Undersign
v1.1
Create Free Account
API Reference Webhooks · Events
Webhooks

Webhook Events

Events describe the signing activity that triggers a webhook notification. The events list on a webhook configuration selects which activity you receive.

What events represent

A webhook event represents a specific occurrence in a signature request's lifecycle, for example a signer acting on a document or the request changing status. When the activity occurs, Undersign sends a notification to the configured URL so your application can react.

Selecting events

Use the events array on the webhook object to choose the activity you're interested in. The documented example subscribes to all available events:

JSON
"events": ["*"]

Start simple. Begin with the wildcard to observe the activity your requests generate, then narrow the list to the events your application actually acts on.

Processing events

Make your event processing safe to repeat: a notification may be delivered more than once, and the same event can arrive again on retry. See Webhook Security.

Event catalog

Documentation pending. The per-event catalog, event names, trigger conditions and payload schemas, is not yet published. Until then, subscribe with ["*"], log the events your requests generate, and gate processing on the event identifiers you observe.