How to create a webhook

To create a Webhook on the KOMPaaS website, go to the ‘Integrations’ section → ‘Webhooks’ tab, and click the ‘New Web Hook’ button.

In the modal window that opens, select the Webhook event type and click ‘Create’.

Configure the Webhook Settings:

1. Title — the name of the Webhook;

2. URL — the address where the Webhook request will be sent;

3. Retry on error — enabled by default. When checked, if there is an error when sending the webhook to the specified URL, it will retry sending it (It is recommended to keep this function enabled).

4. Ignore disabling the Webhook — this function will send the webhook and by default will be considered successful, even if it is not successful (URL is unavailable or another error). Recommended for those who have a long server response time.

   ⚠️Attention! This function is only available to users with administrator rights.

   
   

5. Choose a method — request types: GET or POST:

   • GET — retrieves data from a specified resource (website);
   • POST — sends data to the server for further processing.

6. Select the data type — choose between JSON or Text:

   • JSON — structured data in JSON format;

   • Text — freeform text that can be customized as needed in any format or structure. 

7. Available parameters — event-specific parameters. You can add them to any Webhook settings by clicking on them. 

8. User parameters — additional parameters that will be added to the JSON structure along with the selected blue check marked variables above.

9. Query parameters — URL Query Parameters provide additional information that can be added to the URL. These consist of a parameter and its value, separated by an equals sign (=).

   • Example: https://site.com/?first_param=first_value&second_param=second_value

10. Headers (HTTP Headers) — lines of text in a specific format that either clarify the request or describe the message body content. 

11. After completing the settings, click ‘Save’.

More details on request types:

‘Webhooks’

‘WebHook Event Types’

‘GET request’

‘POST request’