Webhook setup

Webhooks can be configured by a user with the "System admin" role or "Full control" permission in a project. Go to the "Webhooks" section in the project settings and select "Create new webhook."

When creating a new webhook, indicate the following: Name - the name of the webhook that will be displayed on the webhook list; Description - a text description of the webhook for adding a brief comment; Event - the action in the system that will cause the webhook to be sent; URL - the address of the external system to which the query will be sent; Query type - select POST PUT, or DELETE from the drop-down menu. The "Key" fields are the value for headers and the query's parameters.

Use can use special variables in the values of headers and query parameters to send data related to a specific event to an external system.

A list of special variables is predefined for each event based on its context. Special variables available for substitution can be found in instructions and tooltips.

For a POST query, it is possible to send the context of the event in the body of the query. This means that a data model predefined for the event will be sent. Once all of the necessary data has been entered, save the webhook.

All webhooks sent are displayed in a transmission log that can be accessed from the "Webhook settings" tab.