Webhooks

In the process of merging changes into the main branch, it's possible to notify an external service by configuring a webhook. A webhook is an automatic trigger for certain actions in the system that sends this information to any external web service via the HTTP protocol.

Adding a New Webhook

To configure such a notification, you'll need the URL of the external service that should receive the data and to select specific events in the Documently.io application that will trigger the notification. To do this, navigate to Project Settings > Webhooks. The form requires the aforementioned two fields and allows you to activate or deactivate the notification.

The URL field should be a valid public internet address, including the protocol (http/https). The Active toggle allows temporarily disabling the sending of notifications.

The available event is:

• branch.merged – the moment a user merges new changes into the main branch.

When the webhook is active, Documently.io sends a request via the HTTP protocol, using the POST method, to the configured URL. The request includes basic information about the event, such as:

• branchId – the identifier of the branch just merged into the main branch.

• projectId – the identifier of the project where the event occurred.

• mergedAt – the time when the event occurred.

• mergeMessage – a description of the changes merged.

The sent request ignores self-signed certificates and host verification. This means the system will still attempt to send the notification to the requested URL. The result of each request can be viewed in the webhook logs list.