Webhooks are used to get an instant response to an action performed within Signable.
For example when an envelope is sent out (via the API or through the Web App) a ‘send-envelope’ event is posted to a webhook which can be setup either via the API or via your Signable account.

All webhook URLs are POSTed the information. You will be able to retrieve this information from your webhook by grabbing the POST array.

If you want to test the response that you get from the webhook, you can click the ‘Send Test’ link when adding your Webhook in your account. You can also use a service like Requestb.In to view the response.

Below are some sample responses which you will receive depending on which webhook is called.

Send an envelope

Argument Description
envelope_fingerprint A string representing the envelope that was sent
envelope_documents A JSON object string representing the documents within this envelope
envelope_download A string representing a URL to download the envelope
contact_id An integer representing the ID of the contact that the envelope was sent to
contact_name A string representing the name of the contact that the envelope was sent to
contact_email A string representing the email address of the contact that the envelope was sent to
action A string confirming what action was taken. Defaults to ‘send-envelope’.
action_date The date of the action in UTC (GMT)
envelope_meta A JSON string of any meta information that you may have added when sending the envelope

Envelope signed

Argument Description
envelope_fingerprint A string representing the envelope that was sent
envelope_documents A JSON object string representing the documents within this envelope
envelope_fields A JSON encoded array containing all the fields that the signer has completed, including field_id and field_value.
envelope_download A string representing a URL to download the envelope
party_id An integer representing the ID of the party. This will match with the party_id’s in the envelope or template.
contact_id An integer representing the ID of the contact that the envelope was signed by
contact_name An string representing the name of the contact that the envelope was signed by
contact_email An string representing the email of the contact that the envelope was signed by
signature_fingerprint A string representing the fingerprint of the signature
action A string confirming what action was taken. Defaults to ‘signed-envelope’.
action_date The date of the action in UTC (GMT)
envelope_meta A JSON string of any meta information that you may have added when sending the envelope

Envelope signed and completed

Argument Description
envelope_fingerprint A string representing the envelope that was sent
envelope_documents A JSON object string representing the documents within this envelope
envelope_fields A JSON encoded array containing all the fields that the signer has completed, including field_id and field_value.
envelope_download A string representing a URL to download the envelope
action A string confirming what action was taken. Defaults to ‘signed-envelope-complete’.
action_date The date of the action in UTC (GMT)
envelope_meta A JSON string of any meta information that you may have added when sending the envelope

Envelope cancelled

Argument Description
envelope_fingerprint A string representing the envelope that was cancelled
envelope_title A string representing the title of the envelope that was cancelled
action A string confirming what action was taken. Defaults to ‘cancelled-envelope’.
action_date The date of the action in UTC (GMT)
envelope_meta A JSON string of any meta information that you may have added when sending the envelope

Opened envelope

This fires when a signer opens the signing page.

Argument Description
envelope_fingerprint A string representing the envelope that was sent
envelope_documents A JSON object string representing the documents within this envelope
envelope_download A string representing a URL to download the envelope
contact_id An integer representing the ID of the contact that the envelope was sent to
contact_name A string representing the name of the contact that the envelope was sent to
contact_email A string representing the email address of the contact that the envelope was sent to
action A string confirming what action was taken. Defaults to ‘opened-envelope’.
action_date The date of the action in UTC (GMT)
envelope_meta A JSON string of any meta information that you may have added when sending the envelope

Bounced envelope

This fires when an envelope is sent to a signer and the email bounces back.

Argument Description
envelope_fingerprint A string representing the envelope that was sent
envelope_title A string representing the title of the envelope
envelope_bounce_email A string representing the email address that bounced
envelope_bounce_reason A string representing the reason why the email bounced
envelope_bounce_url A string representing the URL which can be navigated to to update the email address and resend
action A string confirming what action was taken. Defaults to ‘bounced-envelope’.
action_date The date of the action in UTC (GMT)
envelope_meta A JSON string of any meta information that you may have added when sending the envelope

Add user

Argument Description
user_id An integer representing the new user ID
user_name A string representing the name of the new user
user_email A string representing the email address of the new user
action A string confirming what action was taken. Defaults to ‘add-user’.
action_date The date of the action in UTC (GMT)

Add client/contact

Argument Description
contact_id An integer representing the new contact ID
contact_name A string representing the name of the new contact
contact_email A string representing the email address of the new contact
action A string confirming what action was taken. Defaults to ‘add-contact’.
action_date The date of the action in UTC (GMT)

Add template

Argument Description
template_fingerprint A string representing the template
template_title A string representing the name of the new template
template_page_total An integer representing the number of pages in this template
template_thumbnails A JSON object string representing the URL’s of the thumbnails of each page of this template
template_pages A JSON object string representing the URL’s of each page of this template
action A string confirming what action was taken. Defaults to ‘add-template’.
action_date The date of the action in UTC (GMT)

Widget signed (but not yet verified)

Argument Description
envelope_fingerprint A string representing the envelope fingerprint of the widget
envelope_title A string representing the title of the envelope of the widget
envelope_documents A JSON object string representing the documents within this envelope
contact_id An integer representing the ID of the contact that the widget was signed by
contact_name An string representing the name of the contact that the widget was signed by
contact_email An string representing the email of the contact that the widget was signed by
action A string confirming what action was taken. Defaults to ‘verify-envelope-widget’.
action_date The date of the action in UTC (GMT)

Widget signed

Argument Description
envelope_fingerprint A string representing the envelope fingerprint of the widget
envelope_title A string representing the title of the envelope of the widget
envelope_documents A JSON object string representing the documents within this envelope
envelope_fields A JSON object string representing the fields within this envelope
envelope_download A string representing a URL to download the envelope
contact_id An integer representing the ID of the contact that the widget was signed by
contact_name An string representing the name of the contact that the widget was signed by
contact_email An string representing the email of the contact that the widget was signed by
signature_fingerprint A string representing the fingerprint of the signature
action A string confirming what action was taken. Defaults to ‘signed-envelope-widget’.
action_date The date of the action in UTC (GMT)