Configure a Webhook

Set up an endpoint to receive webhook notifications and include the configuration in your signature requests.

Endpoint requirements

• The endpoint must be reachable from the internet.
• Use HTTPS so notifications are protected in transit.
• The endpoint should respond promptly to each notification.

Configuration steps

1. Set up an endpoint

   Create an HTTP endpoint that accepts notifications and returns a response. See Webhook Security for validation and logging guidance.

2. Configure the URL

   Use the public HTTPS URL of your endpoint as the webhook url.

3. Choose events

   Set the events list for the notifications you want to receive. The documented example uses ["*"] for all events. See Events.

4. Attach to a request

   Include the webhook object when creating a signature request. Use the Create Signature Request endpoint to add it alongside the request's other fields.

Example webhook object

"webhook": {
  "url": "https://<your-webhook-endpoint>",
  "events": ["*"]
}

Related