The SignEasy API Developer Hub

Welcome to the SignEasy API developer hub. You'll find comprehensive guides and documentation to help you start working with SignEasy API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Webhooks allow you to build or set up applications which subscribe to certain events associated with your SignEasy account. When one of those events is triggered, we'll 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 imagination.

Types of Webhooks

1. App level webhooks

You can use app level webhooks to be notified of events originating from only your app. This is useful if you want to be notified of document activity that was initiated from your integration/app.

To start receiving callbacks for your app level webhooks, all you would have to do is add a custom header in the API call. This header acts as a flag to turn on the callback to your webhooks. If you would like to selectively subscribe to events of a few users, you can choose to include the header for only those users.

Callback Header: Include this header to trigger callbacks to your app level webhook.

X-Client-ID : 5igAbZSN2rIdsthisIDdoesnotreallyworkSF1Zefq5sdfl (your client ID)

2. Global webhooks

Global webhook URLs receive events from all sources (SignEasy web and mobile apps, integrations on 3rd party sites like Zoho & Outlook and even custom integrations). These webhooks can be used to set up automated workflows, eg. exporting all your signed & completed documents to Dropbox or to trigger SMS notifications to your document signers upon signature request initiation or to be used with tools like Zapier & IFTTT.

You will be able to set a global webhook URL for any user through our APIs. Once set, you need not have to take any more action, as and when there are new events for that user your webhooks will receive the callbacks immediately.

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.

Each event type has a specific payload format with the relevant event information. Find the payload for each of these events in the API reference.

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).

Webhooks


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.