Manage Webhooks

Set up webhook endpoints to receive real-time notifications when events happen in your account.

Webhooks let your application receive automatic notifications when something happens in your SignatureAPI account — for example, when a recipient signs an envelope or a deliverable is generated. Instead of polling the API, SignatureAPI sends events directly to a URL you provide.

To manage your webhooks, go to Settings > Webhooks in the Dashboard.

For technical details on event delivery, retries, and signature verification, see Webhooks.

Adding a webhook endpoint

1. Open the Webhooks page

   Go to Settings > Webhooks and click New Webhook Endpoint.

2. Enter the endpoint URL

   Enter the URL where SignatureAPI should send events. This must be a publicly accessible HTTPS URL.

   
3. Select events

   Choose which events you want to receive at this endpoint. You can subscribe to envelope events, recipient events, deliverable events, or sender events.

   See the full list of available events.

4. Choose the mode

   Select whether this endpoint receives test events, live events, or both. Use test mode while building your integration, and add a live endpoint when you’re ready for production.

Signing secret

Each webhook endpoint has a signing secret. Your application uses this secret to verify that incoming requests are genuinely from SignatureAPI.

To find the signing secret, click on the endpoint in Settings > Webhooks.

For instructions on verifying signatures in your code, see Webhook Authentication.

Event types

You can subscribe to events across four categories:

Envelope events

Event	Description
envelope.created	A new envelope was created
envelope.started	The envelope finished processing and recipients are being notified
envelope.completed	All recipients have completed the envelope
envelope.failed	The envelope encountered an internal error
envelope.canceled	The envelope was canceled

Recipient events

Event	Description
recipient.released	The recipient is ready to receive an invitation
recipient.sent	The invitation email was sent
recipient.accessed	The recipient opened the ceremony URL
recipient.viewed	The recipient authenticated and viewed the documents
recipient.completed	The recipient finished all required actions
recipient.rejected	The recipient declined the envelope
recipient.soft_bounced	The invitation email is temporarily undeliverable
recipient.hard_bounced	The invitation email is permanently undeliverable
recipient.failed	An error prevented the invitation from being sent
recipient.replaced	The recipient was replaced with a new person
recipient.resent	The invitation email was resent

Deliverable events

Event	Description
deliverable.generated	The signed document is ready for download
deliverable.failed	Document generation failed

Sender events

Event	Description
sender.created	A sender was created and the verification email was sent
sender.verified	The sender completed email verification
sender.failed	Sender verification failed
sender.deleted	A sender was deleted from the account

Managing endpoints

To edit or delete an endpoint, go to Settings > Webhooks and click on the endpoint.

You can update the URL, change the subscribed events, or delete the endpoint. Deleting an endpoint is permanent — SignatureAPI stops sending events to that URL immediately.

Testing webhooks

Use test-mode webhook endpoints while building your integration. Test events behave the same as live events but are triggered by envelopes created with a test API key.

These tools can help you inspect and debug webhook deliveries:

• Webhook.site — generates a temporary URL and shows every request sent to it.
• ngrok — creates a tunnel from a public URL to your local machine so you can process webhooks locally.

You need the Manage webhooks permission to add or remove webhook endpoints. See Dashboard Users for details on roles and permissions.