Webhooks are a user-defined mechanism that can call another server in response to an event. When a predefined event occurs on the website, the webhook can invoke behavior on another site in near real-time.
Roles
These are the roles that are needed:
- Owner
- can delete webhooks
- can read webhooks
- can write webhooks
Creating a webhook
- Click on ADMIN in the top navigation.
- Choose Settings from the left navigation bar.
- Choose Webhooks from the menu that appears from under the Settings icon.
- On the top of the list:
- Give the webhook a name and, optionally, a description.
- Add the URL which the webhook shall POST a message to.
- If you want headers sent, you can define the header and the value. Click + ADD.
- Select which Event type of objects that shall be listened to.
- Optionally if you want the webhook only to POST for a particular object, input the object ID.
- Select for which realm the object shall be listened to.
- Select which operations that can happen for the object shall be listened to.
- Select whether the webhook is enabled on creation.
- Click + ADD to add the webhook.
Statuses
- If Enabled is selected, the webhook will listen. If the POST to the URL is unsuccessful, it will change the status to Failing.
- If Failing is selected, the webhook will listen. If the POST to the URL is unsuccessful for 5 hours from the status change to Failing, the status will be changed to Disabled.
- If Disabled is selected, the webhook will sleep until the status is changed to Enabled.
Update a webhook
On the admin page:
- Choose Settings from the left navigation bar.
- Choose Webhooks from the menu that appears under the Settings icon.
- Right click on the webhook you wish to update.
- Select Edit Webhook.
- Edit the field.
- Click UPDATE
Delete a webhook
On the Admin page:
- Choose Settings from the left navigation bar.
- Choose Webhooks from the menu that appears under the Settings icon.
- Right click on the webhook you wish to delete.
- Select Delete Webhook.
- Confirm by clicking DELETE