How do I create a webhook?

To set up a webhook:

• Go to Settings at the top right corner of the page.
• Under the Automation tab, click Workflow Actions.
• In the Workflow Actions section, select Webhooks.
• Click + New Webhook.
• Enter mandatory details such as Name and the Module for which you wish to create a webhook.
• Include a short Description about the purpose of the webhook you are creating.
• In the URL & Parameters dropdown, select the preferred HTTP method and enter the URL of the third-party application you wish to notify. The available HTTP methods are:
  • Post: Requests that the data sent must be treated as new
  • Put: Requests that the data sent should be treated as the updated version of the one already sent
  • Delete: Requests that the data sent be deleted

You can also add additional query parameters by clicking Add Parameters and entering the required values in the Key and Value fields. You can add custom parameters like Auth Token, Security Token, API Key, etc.

• In the Headers section, enter additional information that you want to include in your HTTP request.

• Choose either Self-Authorisation or Connections as the Authorisation Type.

• The Body section describes the formats in which you can send your data. The available formats are:

  • Default Payload: All parameters associated with the module are sent to the request body in application/JSON format type.
  • x-www-form-urlencoded: data is encoded and sent to the server.
  • Raw: You are free to choose the parameters sent to the request body.

• Click Save and Execute to check if your webhook is functioning properly.