Use Webhooks

Webhooks can be used to receive notifications about events occurring in DocuSeal. They allow you to automatically synchronize data between DocuSeal and your application or receive real-time event notifications.

For example, you can use webhooks to get notified when templates are created or updated, or when documents are signed. Services like Zapier and Make also work seamlessly with DocuSeal Webhooks.

How to Add a New Webhook

  1. Log in to your DocuSeal account.
  2. Click on your user initials in the top right corner and select Console.
  3. In the left menu, select Webhooks.
  4. On the opened page, you will see a form to create a new webhook. If you already have webhooks set up, they will be listed here. To create a new webhook, click New Webhook in the top right corner.
  5. Enter the URL where you want to receive event notifications.
  6. Below the input field, select the event types you want to receive notifications for.
  7. Click Save to create the new webhook.
  8. Done! You will now receive event notifications from DocuSeal at the specified URL.

How to Add a Webhook Secret to All Notifications

  1. After creating a new webhook, click the Add Secret button in the top right corner.
  2. In the opened window, enter your secret key and value.
  3. Click Save to store the secret key.
  4. Done! All webhook notifications will now include your secret key-value pair in the request headers. This allows you to verify that the notification was sent from DocuSeal.

How to Use Webhooks in a Local Development Environment

  1. When creating a new webhook, enter your local URL where you want to receive event notifications. If the domain is listed as an allowed host, you can use it directly:
    • 0.0.0.0
    • 127.0.0.1
    • localhost
    • host.docker.internal
    • docker.for.mac.localhost
    • docker.for.win.localhost
  2. Click Save to store the new webhook.
  3. Below the URL input field, you will see a command that you can use to start a tunnel, allowing you to receive notifications from DocuSeal.
  4. Open a new terminal and run the copied command.
  5. Done! You can now receive event notifications from DocuSeal in your local development environment.