Skip to content
DocuBot documentation

Webhook guide

You can use webhooks to receive real-time notifications when your documentation updates or when specific repository events occur. This guide helps you connect your external systems to the DocuBot synchronization pipeline to automate your documentation workflows.

Configure the webhook endpoint

In your dashboard settings, navigate to the Webhooks section to provide a destination for event notifications.

  1. Enter the destination URL for your webhook endpoint.
  2. Save the configuration to generate a unique secret key.
  3. Copy the secret key to a secure location; you need this to verify that incoming requests originate from DocuBot.

Select event triggers

Define which repository or system actions should trigger a documentation refresh or notification.

  1. Review the list of available event triggers, such as code pushes or manual sync requests.
  2. Select the checkboxes for the events you want to monitor.
  3. Update your settings to subscribe the webhook to these specific actions.

Verify the payload signature

To maintain security, you must ensure that incoming requests are authentic and originate from the authorized source.

  1. Locate the signature header in the incoming request.
  2. Use your secret key to compute the HMAC signature of the request payload.
  3. Compare your computed signature with the value in the header.
  4. Only process the request if the signatures match.

Test the connection

Confirm that your endpoint is reachable and responding correctly by sending a test event.

  1. Click the Test webhook button in the dashboard.
  2. Check your server logs to confirm receipt of the test payload.
  3. Verify that a successful status code is returned and logged in the webhook history within the dashboard.

Handle delivery failures

Configure how your system responds to timeouts or error codes to ensure reliable integration.

  1. Monitor the delivery status logs in the dashboard to identify failed attempts.
  2. Ensure your server responds within the required timeout period to prevent delivery errors.
  3. Review the automated retry schedule if your endpoint returns an error code.

Support

If you encounter issues during setup or verification, contact our support team at support@ademero.com or visit https://www.ademero.com. You can also reach us by phone at 863-937-0272.