Webhooks

General setup

There is an option to limit the SSP interface to only show webhooks. Please only use this option in case webhooks is your only usage for SSP.

This page will not be visible anymore in case the last option is set to Yes. In order to return to this page, use this URL: http://<ssp>/Common/Admin/settings.aspx

Webhook entrypoint

The workflow automation platform supports the definition of multiple webhook entrypoints. There is no limit to the number of entrypoints that can be configured.

Define new entrypoint

Go to the admin page and select the option “Webhook entry points”

This will show a list of currently defined entry points. Click on the button Add webhook entry point to define a new entry point:

Make sure to copy the URL endpoint and paste it as a webhook destination URL within your sourcing system.

Now every time this event occurs in your sourcing system, the SMTX platform will be triggered and will evaluate all rules associated with this webhook entry point. Go to the tab called Rules, to see which rules are currently defined. Before any rule can be defined, the data required to evaluate the rules should be made available. This data consists out of:

The fields required to evaluate the rules should be added. It is not required to add all fields. To add new body fields click the button ADD just beneath the Callback body values header.

Add all fields in this way, to get a result like this:

If for example additional request data is required that was not provided in the callback body, you can add this data by clicking at the ADD button at the bottom. By clicking ADD this form appears:

The Name is for reference only. The dropdown list webservice shows all webservice calls available within the platform. Select the Infravision Integration Service here, that can retrieve additional data from ITRP. In this example the webservice to get request data is called. Within the webservice it is configured that there is 1 input field called ITRPId. The mapping is used to transfer the Object_Id received within the callback body values to the webservice. Now the webservice has all input required and can get the data from the Infravision Integration Service platform.

Define as many additional webservice calls as required. You can use the result of a webservice call as mapping source for other additional webservice calls. When ready, go to Rules.

Rules

Within Rules you can define for which events something should happen or should be further investigated if something should happen. When a rule condition is true, the associated workflow will start. Within the workflow you are free to do further checks or execute an action.

To add a new rule simply click ADD. Give a rule a name, which is only used for reference. Second, select the process that should start when this rule is true.

To add a condition to the rule drag-and-drop the top green section within the dotted area:

Once dropped, a screen will popup to define the rule condition. All fields defined as callback body values and all fields retrieved by the additional webservices are available to build your condition.

You can add multiple conditions in a single rule:

When the rule condition is ready, click at save and close to store this new rule. From this moment on, everytime ITRP sends out a webhook event and the condition is true, a process will start.

Process

Go to processes to edit your processes:

Open the process you wish to edit. At the General Settings page, only set the name. For basic usage, ignore all other settings, and use their defaults. Go to the tab Edit Steps.

Here you can see all workflow steps that will be executed when this process runs. Below is a basic example of sending an email and closing the process:

The second step visible in the workflow above is to save all ITRP data in a ticket log for future tracking. This step is optional. The first step sends out an email notification. By clicking on the edit button, it can be configured to whom the email is sent and what the content will be.

Under the header “initial email” the content of the email can be configured. Use the option “Use step specific content” for now. A layout doesn’t need to be selected nor attachments.

You can define the email subject and body content. All data defined within the webhook entry point, can be used here to refer to. In case additional information is required, the process should be extended with a webservice call to get the additionally required data.

To refer to any entrypoint data, use the dropdown lists underneath the subject and body fields. Select the option External app field in the first dropdown. The second dropdown will show all available sources, including all webhook entrypoints. Select the desired entrypoint and chose the field you would like to use. For example:

Click ADD to add a reference to this field to the body or subject line.

In case this data is desired in other places, the same reference can be used and looked up in a similar way.

Go to Actor Settings to define who should receive the email message. Most probably the email receiver will be retrieved from ITRP, so make sure to define the correct webservice call within the process or the webhook. In case a webservice lookup is added within the process, use “Previously Entered Fields” instead of “External App” in the first dropdown list.

Finding tickets

The easiest way to see if a webhook event has triggered a new ticket is to search here: http://demo.smt-x.com/ticketing/SearchTickets.aspx#. Use the current date as filter argument on Started From field and click Search button. The list will show all tickets created today:

You can click anywhere on the ticket to open the details. In the details page, information about the request can be found. The ticket will be read-only as the process has been closed automatically.