Skip to content
DocuBot documentation

Webhook guide

You can use webhooks to receive real-time notifications about your documentation lifecycle. This allows you to trigger external workflows, such as updating a status page or notifying a Slack channel, whenever a sync succeeds or fails.

Access webhook settings

To begin the configuration, you must locate the webhook management area within your dashboard.

  1. Open the Workspace settings menu.
  2. Select the Webhooks tab.
  3. Notice that the Webhooks management screen appears, displaying any existing integrations.

Register a destination URL

DocuBot needs a public endpoint to send event notifications.

  1. Enter your public endpoint URL in the Endpoint URL field.
  2. Save the endpoint.
  3. Notice that the system assigns a unique secret key to this integration. You will need this key later to verify that incoming requests are authentic.

Select event triggers

You can choose which specific events should trigger a notification to avoid unnecessary traffic to your server.

  1. Review the list of available event triggers.
  2. Select the events you want to monitor, such as:
    • Sync Succeeded: Fired when a documentation update completes successfully.
    • Sync Failed: Fired when an error occurs during the generation process.
    • Initial Generation: Fired when a new repository is first processed.
  3. Save your selection to ensure the webhook only fires for these specific actions.

Verify the payload signature

For security, you should always validate that the requests your server receives actually originate from DocuBot.

  1. Locate the payload signing secret provided in the dashboard.
  2. Configure your server to calculate an HMAC SHA256 signature of the incoming request body using your secret key.
  3. Compare your calculated signature with the one provided in the request header.
  4. Reject any requests where the signatures do not match to prevent unauthorized access.

Note: The exact header name for the security signature and the sample JSON payload schema are not available in the current repository documentation. If you require these technical details, please contact support.

Test the integration

Before relying on the webhook for production workflows, confirm that your endpoint is reachable.

  1. Click the Send Test Payload button.
  2. Check your server logs to confirm the test payload was received.
  3. Review the Recent deliveries log in the DocuBot dashboard to see the response code returned by your server.

Manage delivery failures

If your endpoint is temporarily unavailable, DocuBot attempts to deliver the notification again.

  1. Monitor the delivery status in your dashboard.
  2. Notice that the system uses an exponential backoff policy for retries, increasing the time between attempts if your server continues to return errors.
  3. Check the retry attempt count in the delivery logs to diagnose persistent connection issues.

Get help

If you encounter issues setting up your webhook integration or need specific payload schemas, please reach out to our support team: