🔁 Webhook
🔔 What is a Webhook?
A webhook allows one system (like OpenSign) to automatically send real-time data or notifications to another system (like your server) when a specific event occurs.
Think of it as a push notification for your backend — instead of continuously checking for updates (polling), a webhook pushes data to your endpoint as soon as an event happens.
🧠 Simple Example
Suppose you're using OpenSign to collect eSignatures:
- When someone signs a document, OpenSign triggers a POST request to your server.
- The request includes data such as the document ID, signer email, and signature status.
- Your server can then process this information — for example, update your CRM, trigger a workflow, or send a confirmation email.
🧭 How to Add a Webhook in OpenSign
Step 1: Log in to your OpenSign account using your credentials.
Step 2: Navigate to Settings → Webhook.
Step 3: Click Add Webhook.
- A popup will appear. Enter your Webhook URL and click Yes to save it.
Note: To enable Live Webhook support, you must upgrade to a paid plan — either the Professional or Teams plan.
🧪 Sandbox Webhook
- You can also add webhook for the Sandbox environment on the same page.
- Sandbox webhook are available on all plans, including the Free plan, and are ideal for development and testing.
Caution: Avoid sending sensitive or confidential data to the Sandbox environment.
📘 API Reference:
You can also manage your webhooks via our API.
See the API documentation here: Save/Update Webhook API
📋 Supported Webhook Events
OpenSign sends event notifications to your configured webhook URL when any of the following actions occur:
- Document Created – A document is created.
- Document Viewed – A signer viewed the document.
- Document Signed – A signer signed the document.
- Document Completed – All required signatures are completed.
- Document Revoked or Declined – The document was revoked or declined.
Each notification is sent as a POST request with a JSON payload containing relevant event data.
🔍 Example Payload: Document Created
{
"event": "created",
"type": "request-sign",
"objectId": "kpeg6Q2rO7",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/851de61f62b60a1f62e03232464fa4bf_81wV17MTebsrRoov.pdf?...",
"name": "Sample Test Doc",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "3556567789"
}
],
"createdAt": "Fri, 16 May 2025 15:02:42 IST"
}
🔍 Example Payload: Document Viewed
{
"event": "viewed",
"type": "request-sign",
"objectId": "kpeg6Q2rO7",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/851de61f62b60a1f62e03232464fa4bf_81wV17MTebsrRoov.pdf?...",
"name": "Sample Test Doc",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "3556567789"
}
],
"viewedBy": "peter.mark1093@gmail.com",
"viewedAt": "Fri, 16 May 2025 16:18:16 IST",
"createdAt": "Fri, 16 May 2025 15:02:28 IST"
}
🔍 Example Payload: Document Signed
{
"event": "signed",
"type": "request-sign",
"objectId": "kpeg6Q2rO7",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/bc2eb56cc9d29a5f222e4a4b5dbbcfbf_signed_sample_test_doc_4858.pdf?...",
"name": "Sample Test Doc",
"note": "Please review and sign this document",
"description": "",
"signer": {
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "3556567789"
},
"signedAt": "Fri, 16 May 2025 16:18:34 GMT+5:30",
"createdAt": "Fri, 16 May 2025 15:02:28 GMT+5:30"
}
🔍 Example Payload: Document Completed
{
"event": "completed",
"type": "request-sign",
"objectId": "kpeg6Q2rO7",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/bc2eb56cc9d29a5f222e4a4b5dbbcfbf_signed_sample_test_doc_4858.pdf?...",
"certificate": "https://legadratw3d.ams3.digitaloceanspaces.com/9c954912f529acb7e4d065ec0521a63b_certificate.pdf?...",
"name": "Sample Test Doc",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "3556567789"
}
],
"completedAt": "Fri, 16 May 2025 16:18:35 GMT+5:30",
"createdAt": "Fri, 16 May 2025 15:02:28 GMT+5:30"
}
🔍 Example Payload: Document Declined
{
"event": "declined",
"type": "request-sign",
"objectId": "1gtDMBHpEY",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/e90c32a45351eb52eb00e0054ae50566_581ZmOn4CwAqnxSF.pdf?...",
"name": "Sample Test Doc ",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "9283784545554"
}
],
"declinedBy": "peter.mark1093@gmail.com",
"declinedReason": "Invalid date format used.",
"declinedAt": "Fri, 16 May 2025 16:25:38 IST",
"createdAt": "Fri, 16 May 2025 16:24:28 IST"
}
❓ Frequently Asked Questions
1. What is the OpenSign Sandbox environment?
The Sandbox is a testing environment designed for developers to safely experiment with OpenSign APIs and workflows. It mirrors the live environment but with testing limitations.
2. Can I use my Live Webhook in the Sandbox?
No. Live Webhooks do not work in the Sandbox environment. You must configure a separate webhook specifically for Sandbox testing.
3. Can I test all webhook events in the Sandbox?
Yes. The Sandbox environment supports all event types, including created
, viewed
, signed
, completed
, and revoked/declined
.
However, some behaviors may be simulated for testing purposes.
💬 Need Help?
If you need help testing your webhook or integrating it into your application, feel free to reach out to our support team at support@opensignlabs.com.
Happy signing with OpenSign™!