Introduction
Events are how we track important changes in your account. When an event occurs, we create an Event object. For example, when a sign request is sent, we create a sign-request-sent event. Note that some actions may cause multiple events to be created. For example, whenever the last participant in a multi-participant sign request completes a sign request, we create both a participant-signed event and a sign-request-completed event.
To keep you informed when an event occurs in your account, we maintain a webhooks system that enables you to have Event objects sent directly to a specified external endpoint.
Your webhook endpoints can be managed in your test or production account settings or via our API using your sandbox or production credentials as applicable.
Event types
The list below includes all of the event types that we currently track. We may add more at any time, so in developing your code, do not assume that only these type of events exist.
template-activated
Occurs when a template is activated.
template-inactivated
Occurs when a template is inactivated.
template-deleted
Occurs when a template is deleted.
template-used
Occurs when a template is used.
sign-request-sent
Occurs when a sign request is sent.
sign-request-completed
Occurs when a sign request is completed by all participants.
sign-request-declined
Occurs when a sign request is declined.
participant-sent
Occurs when a participant is sent a sign request.
participant-viewed
Occurs when a participant views a sign request.
participant-downloaded
Occurs when a participant downloads a sign request.
participant-signed
Occurs when a participant completes a sign request.
participant-declined
Occurs when a participant declines a sign request.
Event and webhook APIs
Most users configure webhook endpoints from their account settings, which provides a convenient user interface for testing and registering your webhook endpoints. You can also configure webhook endpoints via our API using any of the following methods.
Get list of event types
This API returns a list of the event types that can be tracked. It can be used to locate expected enabledEvents values when using our API to create a webhook endpoint or update a webhook endpoint.
Get list of webhooks
This API returns a list of any active webhook endpoints for a specified company.
Get webhook endpoint
This API returns configuration details for a specified webhook endpoint.
Create webhook endpoint
This API creates a new webhook endpoint.
Update webhook endpoint
This API updates a specified webhook endpoint.
Delete webhook endpoint
This API deletes a specified webhook endpoint.