The Webhooks page is where you can view, create, edit, and delete Webhooks. Webhooks are callbacks which are triggered when a change is made to an event with a Webhook assigned, this could be changes to the events title or description and when the event is updated the Webhook will collect the data and send it to the URL specified.
These can be assigned to specific desired events within Control Hub by clicking on an event to navigate to the edit page and then by clicking on the
Webhooks tab. There is also a
Webhooks tab on the left hand navigation panel.
The page is split into two sides:
Add/Edit Webhook URL¶
This section is displayed on the left side of the page.
By default, this is used to
add new Webhooks. If you click on an existing Webhook in the Current Webhooks section, this will update to
edit that Webhook. If you are editing an existing Webhook, there will be an orange “Cancel Editing” button displayed next to the save button.
The Add/Edit Webhook section contains multiple configuration fields, these are:
- Webhook URL
- Use HTTP Basic Authentication
- Use JSON Body
The Webhook URL is the only prerequisite to create a Webhook within Control Hub, if
Use HTTP Basic Authentication is ticked then a username and password must also be set by the user.
This section is displayed on the right side of the page.
In this section you will see a list of all the current Webhook URLs on the system. From this list you can see:
- Webhook URL
In the Actions column, you will see a red X button to delete the Webhook.