Webhook Module

Description

Ushur provides our customers with the ability to interface with any API service using the Webhook module. This module enables API-based integrations from Ushur to any REST-based system. This module will make HTTP requests such as GET, POST, DELETE, etc, get responses, parse them, and save them in Ushur variables/metadata for further processing.

Applications

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

Settings

The main settings of the Webhook module are the following:

• URL (required): API’s REST destination URL and HTTP method to be used.

• Request Headers/Parameters: You can use Key/Value pairs for the parameters and their values.

• Body: As an alternative to spelling out the parameters, you can also copy/paste the request in JSON format.

• Expected Response (required): the expected response code in HTTP response code format.

• Variables: Set variables 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.

Either the Request Header and Parameters or Body should be filled out depending on your usage. The following example shows the parameters in JSON format entered into Body.

• Here, the parameters are entered as “key/value” pairs instead.

  

In both examples, the same request is being made to the same location, and the same response is expected. The only difference is how the parameters were specified. Therefore, how you enter the parameters depends only on efficiency.

Note

Webhook must be enabled from Administrator Settings. Please consult with your CSM if this module is not active on your account.