Using Webhooks

A guide to configuring and using webhooks

Henrik Hofmeister avatar
Written by Henrik Hofmeister
Updated over a week ago

The webhook integration is a way of notifying your own system whenever an execution is complete - wether it failed, succeeded or was stopped. It also contains a payload containing information about what completed allowing you to - using the API - download the results and do whatever post-processing your system requires.


To setup a webhook first navigate to the Addons section:

Here you'll want to find the addon called " webhook" - and click the "Add" button shown above.ย 


Here you'll need to name your addon, and provide the URL to your system. Please note the request example in the bottom - as this is a HTTP POST request to the endpoint with a JSON payload ย 


Lastly you can define or generate a shared secret which will allow you to authenticate requests going to your endpoint is in fact coming from us and not someone trying to exploit your system.


When you've setup your endpoint you can click the "Test configuration" button - which will send an example payload to your endpoint with the type "test" (in the JSON object).ย 


To debug the webhooks - e.g. see that they are being triggered when you expect them to and to see the actual payload easily - we recommend using e.g. Webhook Tester. They provide an easily setup temporary endpoint which shows you all requests made to it.

Did this answer your question?