Webhook Module

Ushur provides customers with an interface with any API service using the Outbound Webhook module. This module enables API-based integrations from Ushur to any REST-based system. This module makes HTTP requests such as Get, Post, Delete, Patch, or Put. It gets responses, parses them, and saves them in Ushur variables or metadata for further processing.

• Configuring the Outbound Webhook Parameters

• Configuring the Inbound Webhook Parameters

Note

Outbound webhooks can be used to interface with CRM software or utilize the Ushur API capabilities from within the platform. For instance, you can send requests using Outbound Webhook to save user preferences inside a database.

Configuring the Outbound Webhook Parameters

The Webhook module can be configured for either the Outbound or the Inbound direction specification. If you toggle between the configuration tabs, the previous configuration specifications will be lost. To configure the Webhook module, follow the steps below:

1. From the Modules list, drag and drop the Webhook Module into the Inspector Panel and double-click to open the configuration window.

   

2. From the API method drop-down select the HTTP method to be used.

3. Enter the complete URL Endpoint, which is the API’s REST destination URL

4. Configure the Timeout seconds value after which the link should time out. N

   Note

   Ensure it is between 0-30 seconds, and add only numerical.

5. If you want to add query parameters, click Edit request body, and select the Request content type Key and Value for the parameters from the table. Click Add to add a new key and value parameter information.

   

6. Click Save.

7. If you want to add additional Request Header information, click to add your information. Click Add to add new information.

   

8. If you want to add additional If you want to add key details and values in the Request Headers box, enter the Key and Value for the headers in the different boxes. Click Add to update additional keys.

   

9. In the Expected response status field under the Response Details section, enter individual codes (e.g., 100, 235) or ranges (e.g., 300-350). The system accepts codes from 100 to 599, codes outside this range will prompt an error message.

10. Select the type of response that is required from the Expected Response Content type dropdown list:

    • text/plain

    • text/HTML

    • application/JSON

    • asset

11. Save the responses or add the keys for tags from the Save Variables from Response dropdown list. Click Edit table to add new Save response values and click Save.

    

Note

Tags can be used to store key values from the API response to Ushur’s local or enterprise variable. Local and enterprise variables can also be used as parameters in the body of the API.

12. Use Check box to select Retry on Failure (Callback URL) option under Error Handling section.

    

Configuring the Inbound Webhook Parameters

Use this webhook to emit an event in an external system, and inbound webhook to check whether an event has occurred.

To configure, follow the steps below:

1. Slide to the Inbound toggle.

   

2. Modify the specific message to be displayed in the Message when triggered text box.

3. Select the content type from the Expected trigger content-type dropdown list. The type can be plain text, text/HTML, application/JSON, or asset type.

4. Tag the responses or add new tags in the Save response values to tags table.

5. Click Save.