How to Create a Webhook

Written By: Dozuki System (and 2 other contributors)

Comments: 0
Favorites: 0

Difficulty

Moderate

Steps

Time Required

Suggest a time??

Introduction

Dozuki’s native webhook feature enables seamless integration with external systems by sending real-time notifications when specific events occur within the platform. Webhooks work by pushing event data to a user-defined URL, allowing businesses to automate workflows and enhance system interoperability without constant polling. For example, Dozuki can use webhooks to notify a third-party system when a new guide is published, an Approval Request is Submitted, or a Work Order Status is Changed. This functionality is ideal for synchronizing data, triggering actions in connected systems, or maintaining up-to-date records across platforms. To use Dozuki webhooks, administrators configure a target URL and select the events they want to monitor. When an event is triggered, Dozuki sends an HTTP POST request to the specified endpoint, often including relevant data in JSON format. This integration capability helps organizations optimize their processes and achieve a higher level of automation and real-time awareness within their operations.

Step 1 Navigate to the Webhook's Homepage

To create and configure webhooks, the user must have administrative privileges.

On the Manage page, within the left-hand navigation section locate the "Configuration" section.

To create and configure webhooks, the user must have administrative privileges.
Navigate to the Manage page by clicking on the Settings icon next to the profile button.
On the Manage page, within the left-hand navigation section locate the "Configuration" section.
Click on "Webhooks".
On the Manage/Webhooks page, you will see any existing webhooks listed along with the blue "Add new Book" button on the right-hand side of the page.
If you don't see the "Webhook" option within the "Configuration" section on the /Manage page, please reach out to support ( support@dozuki.com ) or your CSM to enable this feature.

Step 2 Create a New Webhook

After clicking the "Add new hook" button, you'll be taken to the new Webhook form where you'll input the necessary data under:

After clicking the "Add new hook" button, you'll be taken to the new Webhook form where you'll input the necessary data under:
General settings
and Event settings to create the Webhook.

Step 3

General Settings
Display name: The title that will be displayed.
Description: A description describing what the Webhook is set to accomplish.
URL: The target endpoint (URL) that can receive and process the data sent by the webhook.
This could be: A custom API endpoint you’ve set up. A third-party service like Zapier, Integromat (Make), or a similar tool that integrates with external services.
Secret Key: JWT signed with this secret will be sent in the header "x-webhook-secret" of the webhook request.
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.

Step 4

Event Settings: Select the event(s) you want to trigger the webhook.

The first dropdown contains all event options.

Below are Event sections categorized into four sections.

Event Settings: Select the event(s) you want to trigger the webhook.
The first dropdown contains all event options.
Below are Event sections categorized into four sections.
Approvals: Approval Request Submitted, Status Changed, or Stage Completed.
Work Orders: Work Order Status Changed, Signoff Completed, or Signoff Requested.
Releases: Release Published
Courses: Course Stage expired, Invalidated, or Completed
Within each Manage Category are options to choose all or individual events.

Step 5 Testing a Webhook

After the Webhook is configured, it can be tested.

Click on the "Test Hook" button which will bring up the Test Hook modal.

The endpoint URL and Secret Key will be populated in their respective fields.

After the Webhook is configured, it can be tested.
Click on the "Test Hook" button which will bring up the Test Hook modal.
The endpoint URL and Secret Key will be populated in their respective fields.
The JSON payload will need to be provided.
Each webhook is sent with the same general JSON request body structure: { "title": "Webhook Event Title", "description": "A description of the webhook event.", "siteName": "test site", "siteDomain": "site.dozuki.com", "data": {...} }
Please refer to our API documentation by navigating to https://yoursite.dozuki.com/api/2.0/doc/....
Here you will find documentation on how to structure the data sub-object when testing the Webhook.

Step 6 Webhook Logs

Next to the Details tab, there is a tab labeled "Logs."

This section contains the records of all the callbacks that were executed after a webhook was triggered for a specific webhook.

Click on Detail to view the returned data.

Next to the Details tab, there is a tab labeled "Logs."
This section contains the records of all the callbacks that were executed after a webhook was triggered for a specific webhook.
Click on Detail to view the returned data.
The retrigger button is to the right of the Detail button.
Refresh the page if the retrigger does not appear on the page after the first click.

Step 7 View Permissions

Admins can grant standard users, authors, and/or teams view/edit permission for certain webhooks.

On the /Manage/Webhooks page, click on "View Permissions" in the top right corner.

Admins can grant standard users, authors, and/or teams view/edit permission for certain webhooks.
On the /Manage/Webhooks page, click on "View Permissions" in the top right corner.
Type in the name of the user or team to grant edit access.