A Webhook is a tool that allows you to receive a notification for a certain event. It allows you to set up an HTTPS URL in our platform for certain events and you will receive a JSON POST event in that URL, with specific event data.
Currently, we support registering for the following events:
An item was created and it is connecting to provider.
An item was updated and synced successfully.
An item was encountered errors in its execution.
An item it's blocked waiting for user input to continue.
Receive all events.
To register for a specific event you will have to send the desired one as the event to attach. There is also an option
all to receive all events associated.
We only accept HTTPS URLs. Localhost URL are not allowed to be used, you will have to provide an HTTPS URL using ngrok or other tools to provide public secured URLs.
Just to review the functionality you can use RequestCatcher, which is a tool that will just receive our notification and show you the payload. You can easily create a catcher with just a name in seconds.
When doing the POST request, all webhooks will send the following parameters in JSON format:
- id: primary identifier of the resource that was notified.
- event: Event's name (item/created, item/updated, item/error, etc.)
A webhook notification expects a 2XX status code in the response if you need to do some work with the event you should process after replying back.
If there is a communication error (no response or an error) we will retry the notification 10 times over the next three days in incremental intervals of time. Then the notification will be lost.
For more information see Webhook in our API reference.
Updated about 1 month ago