Dozuki Webhooks
Webhooks allow you to subscribe to events that happen in Dozuki. When the event happens, we send information about that event to the webhook’s configured URL. This allows you to create real-time integrations between Dozuki and other software systems.
To see which events are available and configure your webhooks, please refer to the Manage Webhooks page.
Webhook Request Body
Each webhook is sent with the same general JSON request body structure:
{
"title": "Webhook Event Title",
"description": "A description of the webhook event.",
"siteName": "dozuki",
"siteDomain": "help.dozuki.com",
"data": {...}
}- title
- The title of the webhook event. Use this to identify which event the webhook is for.
- description
- A simple description of the event which triggered the webhook.
- siteName
- The name of the Dozuki site that sent the webhook. This may be useful for customers that have multiple sites.
- data
- Each webhook will include its own set of data based on the event. Find the Dozuki API endpoint that relates to the webhook event to see the structure of the data. For example, the Approval Request Submitted webhook will have the same data as the response body of the GET approval request API endpoint.
Webhook Authentication
When configuring a webhook on the Manage Webhooks page you must provide a Secret Key. This key must be at least 8 characters long and is used to sign the JSON Web Token (JWT) that is sent with the webhook request. You can use your Secret Key to validate the signature of this JWT as a form of authentication on an incoming webhook request.
Note: The JWT can be found on the "x-webhook-secret" header of the webhook request.