Skip to content
/
User added

Signable API (1.0.0)

The Signable API provides secure and efficient access to Signable's electronic signature platform. With this RESTful API, you can send documents for signature, manage templates, track envelope status, and automate your document workflows from within your own applications.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Signable
help@signable.co.uk
License
Proprietary
Terms of Service
Languages
Servers
Production server
https://api.signable.co.uk/v1/

Partners

Manage partner integrations.

Operations

Envelopes

Send, track, and manage documents for e-signature.

Operations

Templates

Create and reuse predefined document templates.

Operations

Contacts

Manage contact details for signers and stakeholders.

Operations

Users

Control user accounts and roles.

Operations

Branding

Customize visual and branding settings for emails.

Operations

Settings

Configure account-wide preferences and defaults.

Operations

Webhooks

Create, read, update, and delete Webhook subscriptions.

Operations

Webhook Events

Definitions for asynchronous event payloads sent by Signable.

Webhooks

Envelope sentWebhook

Request

This webhook is triggered after an envelope has been successfully processed and sent. It delivers information about the envelope, the recipient, any additional metadata, and a download URL.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
envelope_fingerprintstringrequired

A string representing the envelope that was sent

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

A JSON string representing the documents within the envelope

Example: "[{\"document_title\":\"Untitled document\",\"document_fingerprint\":\"584ea8b41b0d4c17a96b967433b211e6\",\"document_pdf\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\",\"document_download\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\"}]"
envelope_downloadstring(uri)required

A URL to download the envelope contents

Example: "https://api.signableapi.com/shareable/envelope?t=03cbb315-4f68-400d-a5cc-c2884996d061"
contact_idintegerrequired

The ID of the contact the envelope was sent to

Example: 14029945
contact_namestringrequired

The name of the contact the envelope was sent to

Example: "Abby Smith"
contact_emailstring(email)required

The email address of the contact the envelope was sent to

Example: "abby@signable.co.uk"
actionstringrequired

The action taken. Defaults to send-envelope.

Example: "send-envelope"
action_datestring(date-time)required

The UTC timestamp of when the action occurred

Example: "2025-06-20T15:50:10+00:00"
envelope_metastring

A JSON string of any meta information added when sending the envelope

Example: ""
envelope_signing_embedstring

An iframe URL for embedded signing, if enabled

Example: "<iframe src=\"https://sign.signable.app/#2KnUUnVQTxtkpV8rmWqem9qXpvaTU2hYLHHyQD7WtdQ\" width=\"100%\" height=\"95%\" frameborder=\"0\" style=\"border: 0; overflow: hidden\"></iframe>"
application/x-www-form-urlencoded
envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_title%22%3A%22Untitled%20document%22%2C%22document_fingerprint%22%3A%22584ea8b41b0d4c17a96b967433b211e6%22%2C%22document_pdf%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%2C%22document_download%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%7D%5D&envelope_download=https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fenvelope%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061&envelope_signing_embed=%3Ciframe%20src%3D%22https%3A%2F%2Fsign.signable.app%2F%232KnUUnVQTxtkpV8rmWqem9qXpvaTU2hYLHHyQD7WtdQ%22%20width%3D%22100%25%22%20height%3D%2295%25%22%20frameborder%3D%220%22%20style%3D%22border%3A%200%3B%20overflow%3A%20hidden%22%3E%3C%2Fiframe%3E&contact_id=14029945&contact_name=Abby%20Smith&contact_email=abby%40signable.co.uk&action=send-envelope&action_date=2025-06-20T15%3A50%3A10%2B00%3A00&envelope_meta=

Responses

Acknowledge receipt

Envelope signedWebhook

Request

This webhook is triggered when a recipient completes signing an envelope. It includes detailed information about the envelope, signer, documents, custom fields, and signature fingerprint.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
envelope_fingerprintstringrequired

A string of the signed envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

JSON string of the documents within the envelope

Example: "[{\"document_title\":\"Make Tests\",\"document_fingerprint\":\"584ea8b41b0d4c17a96b967433b211e6\",\"document_pdf\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\",\"document_download\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\"}]"
envelope_fieldsstringrequired

JSON string of completed fields in the envelope

Example: "[{\"field_id\":458946901,\"field_name\":\"Untitled\",\"field_type\":\"text\",\"field_value\":\"1st Aug\"},{\"field_id\":458946905,\"field_name\":\"Untitled\",\"field_type\":\"text\",\"field_value\":\"hiousfdjp\"}]"
envelope_downloadstring(uri)required

URL to download the full signed envelope

Example: "https://api.signableapi.com/shareable/envelope?t=03cbb315-4f68-400d-a5cc-c2884996d061"
contact_idintegerrequired

ID of the signer

Example: 7418454
contact_namestringrequired

Name of the signer

Example: "Abby"
contact_emailstring(email)required

Email address of the signer

Example: "abby@signable.co.uk"
company_idintegerrequired

ID of the sub-account (company) the envelope belongs to

Example: 64034
user_idintegerrequired

Internal user ID associated with the signing action

Example: 267199
signature_fingerprintstringrequired

Unique fingerprint identifying the signature event

Example: "584ea8b41b0d4c17a96b967433b211e6"
client_ipstring(ipv4)required

IP address of the device used to sign

Example: "65.179.58.205"
envelope_metastring

A JSON string of any additional metadata attached to the envelope

Example: ""
actionstringrequired

The action taken. Defaults to signed-envelope.

Example: "signed-envelope"
action_datestring(date-time)required

UTC timestamp of when the signing occurred

Example: "2025-08-01T14:37:47+00:00"
application/x-www-form-urlencoded
envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_title%22%3A%22Make%20Tests%22%2C%22document_fingerprint%22%3A%22584ea8b41b0d4c17a96b967433b211e6%22%2C%22document_pdf%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%2C%22document_download%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%7D%5D&envelope_fields=%5B%7B%22field_id%22%3A458946901%2C%22field_name%22%3A%22Untitled%22%2C%22field_type%22%3A%22text%22%2C%22field_value%22%3A%221st%20Aug%22%7D%5D&envelope_download=https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fenvelope%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061&contact_id=7418454&contact_name=Abby&contact_email=abby%40signable.co.uk&company_id=64034&user_id=267199&signature_fingerprint=584ea8b41b0d4c17a96b967433b211e6&client_ip=87.177.50.205&envelope_meta=&action=signed-envelope&action_date=2025-08-01T14%3A37%3A47%2B00%3A00

Responses

Acknowledge receipt

Envelope cancelledWebhook

Request

This webhook is triggered when an envelope is cancelled before completion. It includes the envelope fingerprint, user details, and any metadata associated with the envelope.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
envelope_fingerprintstringrequired

A string representing the cancelled envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_titlestringrequired

The title of the cancelled envelope

Example: "tagstest - Copy"
actionstringrequired

The action taken. Defaults to cancelled-envelope.

Example: "cancelled-envelope"
action_datestring(date-time)required

The UTC timestamp of when the envelope was cancelled

Example: "2025-08-06T12:59:03+00:00"
envelope_metastring

A JSON string of any meta information associated with the envelope

Example: ""
company_idintegerrequired

The ID of the company linked to the envelope

Example: 64034
user_idintegerrequired

The ID of the user who cancelled the envelope

Example: 267199
client_ipstring(ipv4)required

The IP address of the user or system that triggered the cancellation

Example: "203.0.113.42"
application/x-www-form-urlencoded
envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_title=tagstest%20-%20Copy&action=cancelled-envelope&action_date=2025-08-06T12%3A59%3A03%2B00%3A00&envelope_meta=&company_id=64034&user_id=267199&client_ip=203.0.113.42

Responses

Acknowledge receipt

Envelope signed & completeWebhook

Request

This webhook is triggered when all required parties have completed signing an envelope. It includes the envelope fingerprint, documents, any captured field data, and a download link.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
envelope_fingerprintstringrequired

A string representing the signed envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

A JSON string representing the signed documents within the envelope

Example: "[{\"document_title\":\"Word Doc\",\"document_fingerprint\":\"584ea8b41b0d4c17a96b967433b211e6\",\"document_pdf\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\",\"document_download\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\"}]"
envelope_downloadstring(uri)required

A URL to download the completed envelope

Example: "https://api.signableapi.com/shareable/envelope?t=03cbb315-4f68-400d-a5cc-c2884996d061"
envelope_fieldsstringrequired

A JSON string of captured field values within the envelope

Example: "[{\"field_id\":460133805,\"field_name\":\"Untitled\",\"field_type\":\"text\",\"field_value\":\"Test\"}]"
envelope_metastring

A JSON string of any meta information associated with the envelope

Example: ""
actionstringrequired

The action taken. Defaults to signed-envelope-complete.

Example: "signed-envelope-complete"
action_datestring(date-time)required

The UTC timestamp of when the envelope was fully signed

Example: "2025-08-07T10:14:33+00:00"
company_idintegerrequired

The ID of the company associated with the envelope

Example: 64034
user_idintegerrequired

The ID of the user who sent or owns the envelope

Example: 267199
client_ipstring(ipv4)required

The IP address of the client that triggered the completion

Example: "203.0.113.17"
application/x-www-form-urlencoded
envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_title%22%3A%22Word%20Doc%22%2C%22document_fingerprint%22%3A%22584ea8b41b0d4c17a96b967433b211e6%22%2C%22document_pdf%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%2C%22document_download%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%7D%5D&envelope_download=https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fenvelope%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061&envelope_fields=%5B%7B%22field_id%22%3A460133805%2C%22field_name%22%3A%22Untitled%22%2C%22field_type%22%3A%22text%22%2C%22field_value%22%3A%22Test%22%7D%5D&envelope_meta=&action=signed-envelope-complete&action_date=2025-08-07T10%3A14%3A33%2B00%3A00&company_id=64034&user_id=267199&client_ip=203.0.113.17

Responses

Acknowledge receipt

Envelope rejectedWebhook

Request

This webhook is triggered when a recipient rejects an envelope. It includes details about the envelope, the rejecting contact, and relevant metadata.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to rejected-envelope.

Example: "rejected-envelope"
action_datestring(date-time)required

The UTC timestamp of when the action occurred

Example: "2025-08-07T11:10:39+00:00"
envelope_fingerprintstringrequired

A string representing the rejected envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
document_idintegerrequired

The ID of the document that was rejected

Example: 0
document_titlestringrequired

The title of the rejected document

Example: "Word Doc"
contact_idintegerrequired

The ID of the contact who rejected the envelope

Example: 7418454
contact_namestringrequired

The name of the contact who rejected the envelope

Example: "Abby"
contact_emailstring(email)required

The email address of the contact who rejected the envelope

Example: "abby@signable.co.uk"
signature_fingerprintstringrequired

A fingerprint identifying the signature session that triggered the rejection

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_metastring

A JSON string of any meta information added to the envelope

Example: ""
client_ipstring(ipv4)required

The IP address from which the rejection was submitted

Example: "203.0.113.42"
application/x-www-form-urlencoded
action=rejected-envelope&action_date=2025-08-07T11%3A10%3A39%2B00%3A00&envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&document_id=0&document_title=Word%20Doc&contact_id=7418454&contact_name=Abby&contact_email=abby%40signable.co.uk&signature_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_meta=&client_ip=203.0.113.42

Responses

Acknowledge receipt

Envelope openedWebhook

Request

This webhook is triggered when a recipient opens an envelope. It includes basic information about the envelope, the recipient, and associated documents.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to opened-envelope.

Example: "opened-envelope"
action_datestring(date-time)required

The UTC timestamp of when the envelope was opened

Example: "2025-08-07T10:14:26+00:00"
company_idintegerrequired

The ID of the company that owns the envelope

Example: 64034
contact_idintegerrequired

The ID of the contact who opened the envelope

Example: 7418454
contact_namestringrequired

The name of the contact who opened the envelope

Example: "Abby"
contact_emailstring(email)required

The email address of the contact who opened the envelope

Example: "abby@signable.co.uk"
envelope_fingerprintstringrequired

A string identifying the opened envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

A stringified JSON array of documents in the envelope

Example: "[{\"document_title\":\"Blank Word Doc\",\"document_fingerprint\":\"584ea8b41b0d4c17a96b967433b211e6\",\"document_pdf\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\",\"document_download\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\"}]"
envelope_downloadstring(uri)required

A download link for the entire envelope

Example: "https://api.signableapi.com/shareable/envelope?t=03cbb315-4f68-400d-a5cc-c2884996d061"
envelope_metastring

A JSON string of any meta information added to the envelope

Example: ""
user_idintegerrequired

The ID of the user associated with this event

Example: 267199
client_ipstring(ipv4)required

The IP address from which the envelope was opened

Example: "203.0.113.106"
application/x-www-form-urlencoded
action=opened-envelope&action_date=2025-08-07T10%3A14%3A26%2B00%3A00&company_id=64034&contact_id=7418454&contact_name=Abby&contact_email=abby%40signable.co.uk&envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_title%22%3A%22Blank%20Word%20Doc%22%2C%22document_fingerprint%22%3A%22584ea8b41b0d4c17a96b967433b211e6%22%2C%22document_pdf%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%2C%22document_download%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%7D%5D&envelope_download=https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fenvelope%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061&envelope_meta=&user_id=267199&client_ip=203.0.113.106

Responses

Acknowledge receipt

Envelope email bouncedWebhook

Request

Triggered when an email to a signer fails to deliver.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to bounced-envelope.

Example: "bounced-envelope"
action_datestring(date-time)required

The UTC timestamp of when the email bounced

Example: "2025-08-07T11:33:03+00:00"
company_idintegerrequired

The ID of the company that owns the envelope

Example: 64034
envelope_bounce_emailstring(email)required

The email address that bounced

Example: "abby@singable.co.uk"
envelope_bounce_reasonstringrequired

The reason the email failed to deliver

Example: "unable to get mx info: failed to get IPs from PTR record: lookup <nil>: unrecognized address"
envelope_bounce_urlstring(uri)required

A link to view the bounce details

Example: "https://app.signable.co.uk/envelope/bounce/584ea8b41b0d4c17a96b967433b211e6/584ea8b41b0d4c17a96b967433b211e6"
envelope_fingerprintstringrequired

A string identifying the bounced envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
client_ipstring(ipv4)required

The IP address from which the bounce originated

Example: "198.51.100.36"
application/x-www-form-urlencoded
action=bounced-envelope&action_date=2025-08-07T11%3A33%3A03%2B00%3A00&company_id=64034&envelope_bounce_email=abby%40singable.co.uk&envelope_bounce_reason=unable%20to%20get%20mx%20info%3A%20failed%20to%20get%20IPs%20from%20PTR%20record%3A%20lookup%20%3Cnil%3E%3A%20unrecognized%20address&envelope_bounce_url=https%3A%2F%2Fapp.signable.co.uk%2Fenvelope%2Fbounce%2F584ea8b41b0d4c17a96b967433b211e6%2F584ea8b41b0d4c17a96b967433b211e6&envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&client_ip=198.51.100.36

Responses

Acknowledge receipt

Widget completed (Awaiting verification)Webhook

Request

This webhook is triggered when a recipient signs an envelope via the widget, but has not yet verified. It includes contact and document details.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to verify-envelope-widget.

Example: "verify-envelope-widget"
action_datestring(date-time)required

The UTC timestamp of when the envelope was signed

Example: "2025-08-07T11:32:54+00:00"
company_idintegerrequired

The ID of the company that owns the envelope

Example: 64034
contact_idintegerrequired

The ID of the contact who signed the envelope

Example: 8117397
contact_namestringrequired

The name of the contact who signed the envelope

Example: "Abby"
contact_emailstring(email)required

The email address of the contact who signed the envelope

Example: "abby@signable.co.uk"
envelope_fingerprintstringrequired

A string identifying the signed envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

A stringified JSON array of documents in the envelope

Example: "[{\"document_fingerprint\":\"584ea8b41b0d4c17a96b967433b211e6\",\"document_title\":\"Word Doc\",\"document_download\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\"}]"
envelope_metastring

A JSON string of any meta information added to the envelope

Example: "{\"envelope_title\":\"Word Doc\"}"
user_idintegerrequired

The ID of the user associated with this event

Example: 0
client_ipstring(ipv4)required

The IP address from which the envelope was signed

Example: "203.0.113.123"
application/x-www-form-urlencoded
action=verify-envelope-widget&action_date=2025-08-07T11%3A32%3A54%2B00%3A00&company_id=64034&contact_id=8117397&contact_name=Abby&contact_email=abby%40signable.co.uk&envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_fingerprint%22%3A%22584ea8b41b0d4c17a96b967433b211e6%22%2C%22document_title%22%3A%22Word%20Doc%22%2C%22document_download%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%7D%5D&envelope_meta=%7B%22envelope_title%22%3A%22Word%20Doc%22%7D&user_id=0&client_ip=203.0.113.123

Responses

Acknowledge receipt

Widget signature verifiedWebhook

Request

This webhook is triggered when a recipient verifies their signed envelope through the verification email. It includes details about the contact, documents, and verification.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to verified-envelope-widget.

Example: "verified-envelope-widget"
action_datestring(date-time)required

The UTC timestamp of when the envelope was verified

Example: "2025-08-07T12:10:48+00:00"
company_idintegerrequired

The ID of the company that owns the envelope

Example: 64034
contact_idintegerrequired

The ID of the contact who verified the envelope

Example: 8117397
contact_namestringrequired

The name of the contact who verified the envelope

Example: "Abby"
contact_emailstring(email)required

The email address of the contact who verified the envelope

Example: "abby@signable.co.uk"
envelope_fingerprintstringrequired

A string identifying the verified envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

A stringified JSON array of documents in the envelope

Example: "[{\"document_title\":\"Word Doc\",\"document_fingerprint\":\"584ea8b41b0d4c17a96b967433b211e6\",\"document_pdf\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\",\"document_download\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\"}]"
envelope_downloadstring(uri)required

A download link for the entire envelope

Example: "https://api.signableapi.com/shareable/envelope?t=03cbb315-4f68-400d-a5cc-c2884996d061"
envelope_fieldsstring

A stringified JSON array of fields completed during verification

Example: "[{\"field_id\":460176431,\"field_name\":\"Untitled\",\"field_type\":\"text\",\"field_value\":\"Abby\"}]"
envelope_metastring

A JSON string of any meta information added to the envelope

Example: "{\"envelope_title\":\"Word Doc\"}"
signature_fingerprintstringrequired

A string identifying the verification applied

Example: "584ea8b41b0d4c17a96b967433b211e6"
client_ipstring(ipv4)required

The IP address from which the envelope was verified

Example: "203.0.113.124"
application/x-www-form-urlencoded
action=verified-envelope-widget&action_date=2025-08-07T12%3A10%3A48%2B00%3A00&company_id=64034&contact_id=8117397&contact_name=Abby&contact_email=abby%40signable.co.uk&envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_title%22%3A%22Word%20Doc%22%2C%22document_fingerprint%22%3A%22584ea8b41b0d4c17a96b967433b211e6%22%2C%22document_pdf%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%2C%22document_download%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%7D%5D&envelope_download=https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fenvelope%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061&envelope_fields=%5B%7B%22field_id%22%3A460176431%2C%22field_name%22%3A%22Untitled%22%2C%22field_type%22%3A%22text%22%2C%22field_value%22%3A%22Abby%22%7D%5D&envelope_meta=%7B%22envelope_title%22%3A%22Word%20Doc%22%7D&signature_fingerprint=584ea8b41b0d4c17a96b967433b211e6&client_ip=203.0.113.124

Responses

Acknowledge receipt

Template addedWebhook

Request

This webhook is triggered when a new template is added to the account. It includes basic information about the template, including its title and fingerprint.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to add-template.

Example: "add-template"
action_datestring(date-time)required

The UTC timestamp of when the template was added

Example: "2025-08-07T12:36:56+00:00"
company_idintegerrequired

The ID of the company that added the template

Example: 64034
template_fingerprintstringrequired

A string identifying the newly added template

Example: "584ea8b41b0d4c17a96b967433b211e6"
template_titlestringrequired

The title of the added template

Example: "Signable Contract"
template_page_totalintegerrequired

The number of pages in the template

Example: 5
template_pagesArray of objectsrequired

An array of page metadata (if available)

template_thumbnailsArray of strings(uri)required

An array of thumbnail URLs (if available)

client_ipstring(ipv4)required

The IP address from which the template was added

Example: "203.0.113.150"
application/x-www-form-urlencoded
action=add-template&action_date=2025-08-07T12%3A36%3A56%2B00%3A00&company_id=64034&template_fingerprint=584ea8b41b0d4c17a96b967433b211e6&template_title=Signable%20Contract&template_page_total=5&template_pages=%5Bobject%20Object%5D&template_thumbnails=http%3A%2F%2Fexample.com&client_ip=203.0.113.150

Responses

Acknowledge receipt

Contact addedWebhook

Request

This webhook is triggered when a new contact is added to the account. It includes basic information about the contact and the company that added them.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to add-contact.

Example: "add-contact"
action_datestring(date-time)required

The UTC timestamp of when the contact was added

Example: "2025-08-07T12:41:52+00:00"
company_idintegerrequired

The ID of the company that added the contact

Example: 64034
contact_idintegerrequired

The ID of the newly added contact

Example: 17499057
contact_namestringrequired

The name of the contact

Example: "Abby"
contact_emailstring(email)required

The email address of the contact

Example: "abby@signable.co.uk"
client_ipstring(ipv4)required

The IP address from which the contact was added

Example: "203.0.113.150"
application/x-www-form-urlencoded
action=add-contact&action_date=2025-08-07T12%3A41%3A52%2B00%3A00&company_id=64034&contact_id=17499057&contact_name=Abby&contact_email=abby%40signable.co.uk&client_ip=203.0.113.150

Responses

Acknowledge receipt

User addedWebhook

Request

This webhook is triggered when a new user is added to the account. It includes identifying information about the user and their assigned role.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to add-user.

Example: "add-user"
action_datestring(date-time)required

The UTC timestamp of when the user was added

Example: "2025-08-07T13:03:39+00:00"
company_idintegerrequired

The ID of the company the user was added to

Example: 215769
user_idintegerrequired

The ID of the new user

Example: 840786
user_namestringrequired

The name of the new user

Example: "Abby"
user_emailstring(email)required

The email address of the new user

Example: "abby@signable.co.uk"
rolestringrequired

The assigned role of the new user

Example: "user"
client_ipstring(ipv4)required

The IP address from which the user was added

Example: "203.0.113.150"
application/x-www-form-urlencoded
action=add-user&action_date=2025-08-07T13%3A03%3A39%2B00%3A00&company_id=215769&user_id=840786&user_name=Abby&user_email=abby%40signable.co.uk&role=user&client_ip=203.0.113.150

Responses

Acknowledge receipt