Callbacks on the API v.1

The API offers two types of callback, or 'webhooks'. We recommend you use these callbacks and not polling.

Option 1 ('all') - Everything every 6 minutes; or

Option 2 ('signed') - a notification when a document is signed.

Option 1. Everything every 6 minutes.

Data is POSTED to you in two sections, 'data’ and 'signed’. The data section is a JSON object that is a list of dictionaries of the changes. The dictionaries are a record of each change to document and signer status in the order they occured. The second section is a signed string (base64 encoded) you can use to verify the data is genuine should you wish. Contact us for the X509 certificate.

The data contains a list of dictionaries that contains the notification information.

This tells you that signer "/api/v1/signer/[signer-id]/" changed to status 40 (signed) at 2018-03-20T07:09:52, and that document '/api/v1/document/[doc-id]/' was fully signed (status 30) at 2018-03-20T07:09:52. (A signed document has status 30, while a signed signer has status 40.) The dictionary will contain each status change in order they occured with the timestamp, so it is likely to contain multiple status changes for a single signer.

Combine your callback with an overnight sync. For syncing use the /document/ endpoint and the special query parameter ?cache=1. This is a fast and efficient way to get back the status of all your outstanding documents. See API /document/ endpoint for more information.