Undersign
v1.1
Create Free Account
Reference · Data Models

Webhook Model

A webhook configuration attached to a signature request, defining where notifications are sent and which events are subscribed.

Schema

JSON
{
  "url": "https://example.com/webhook",
  "events": ["*"]
}

Fields

FieldRequiredTypeDescription
url required string Your HTTPS endpoint that receives notifications.
events required array The events subscribed. The documented example uses ["*"].

Usage

Include the webhook object in a signature request to receive notifications for it. See Configure a Webhook and Webhook Security.