Webhooks

Webhooks allow you to build or set up applications which subscribe to certain events associated with your OAuth application. When one of those events is triggered, Signeasy will send an HTTP POST payload to the webhook's configured URL.

Webhooks can be used to update your internal or external dashboards, trigger sales workflows, update a document archive, or even trigger a 3rd party workflow. You're only limited by your creativity.

Create a webhook

You can create and configure a new callback URL by logging into your developer portal and navigating to the webhooks tab of your application.

Subscribe to callback events

In the create webhook interface, you'd be able to provide your webhook endpoint URL and subscribe to the callback events associated with the e-signature lifecycle.

Events

The following events trigger a callback to the webhook you have configured for your or your users' account.

Request Signature Events

Event Name	Description
`rs.initiated`	Any time a new signature request is initiated by the user.
`rs.link_sent`	When the document recipients receive their link to sign the document in their email inbox.
`rs.viewed`	Any time a recipient views the document they have been asked to sign.
`rs.signed`	When one of the recipients signs the document. The pending document is not yet complete.
`rs.declined`	When a recipient declines to sign the document.
`rs.voided`	When the user voids the signature request of a document.
`rs.reminded`	When the user sends a reminder to the signers of the document.
`rs.completed`	When all the recipients of the document have completed signing.
`document.signed`	When a user completes self signing using the embedded self sign flow.
`rs.bulksign_completed`	When a bulk signing is completed.
`rs.bulksign_declined`	When a bulk signing is declined.

Each event type has a specific payload format with the relevant event information.

In addition to the information related to the signature request, webhook payloads include the user who performed the event (event_user) and the app that the event originated from (if applicable).