0.0.7 • Published 1 year ago
wbb-solarwinds v0.0.7
SolarWinds
With this integration you can create Incidents in the SolarWinds Service Desk platform. Information about the Incidents you can create can be found here -> https://apidoc.samanage.com/#tag/Incident. Note that other types of ticket are not yet supported.
Blocks Provided
At present, only two blocks are provided for SolarWinds, and it is explained below.
| Handler Name | Purpose |
|---|---|
| Create Indicent | This block will ask any necessary questions, and once complete send the data to the APIs to create the Incident. Parameters, explained below, allow you to determine what happens next. |
| Settings Error | Used whenever the blocks are used with an incorrect set of parameters. |
Handler Names
The following handler names and their functions are available :
| Handler Name | Purpose |
|---|---|
| create-incident | Raise a new Incident using the information provided and provide a ticket number back to the user. |
Configuration Options
Within the function there are a number of options that can be set to configure the behaviour of the integration. The tables below show the settings that are available for each handler.
create-incident
| Property | Required | Description |
|---|---|---|
| api_token | true | The API authentication token for use with API calls. Please see https://apidoc.samanage.com/#section/General-Concepts/Authentication for more information. |
| root_url | true | The root URL for API calls, typically either https://apieu.samanage.com or https://api.samanage.com |
| requester | true | Either a static email address of the requester, or the name of a property contained within the form submitted. For example, either andy@wbb.ai or email to pull the email address from a form question. |
| assignee | true | Either the id of an assignee to be associated with this Incident, or an object. In the case where its an object this value will be passed through directly. |
| category | true | This can either be a string, or an object. In the case where its a string, it'll set the category to the one whos name matches the value provided. If its an object it will be passed through directly. |
| subcategory | true | This can either be a string, or an object. In the case where its a string, it'll set the subcategory to the one whos name matches the value provided. If its an object it will be passed through directly. |
| priority | false | A string representing the priority for this incident, ie Low. |
| state_id | true | The state_id to be used when creating this ticket. |
| site_id | false | Passed directly through as the site_id parameter on the Incident. |
| department_id | false | Passed directly through as the department_id parameter on the Incident. |
| name | true | This can either be a static string, or the property name from within the form data submitted. In the latter case the name of the ticket will be set to what the user entered in the form. |
| description | true | This can either be a static string, or the property name from within the form data submitted. In the latter case the desription of the ticket will be set to what the user entered in the form. |
| response_string | true | A String containing a response to the user. This string can contain the following parameters, id, number, ticketName, ticketDescription, assignee, and link, along with anything provided in the settings of the block. Parameters must be enclosed in double %% and if set correctly will be substituted with the relevant properties from the new Incident created. For example, Ticket Number is %%number%% will return to the user Ticket Number is 12345. |
| next_block | false | If set, will direct the user to this block ID to continue the conversation. |
| error_block | true | The block ID to use for cases where the creation of the Incident has failed. |
| live | false | If set to true will call the API and create the incident. If not set, or set to false then it'll return dummy information. |