Webhooks
Get notified using webhooks
Webhooks
Get notified using webhooks
1
Create a webhook
Specify your target URL and the event you want to track between the following options:
- ENVELOPE_COMPLETED
- ENVELOPE_EXPIRED
- ENVELOPE_DECLINED
- ENVELOPE_VOIDED
Create a webhook
Endpoint details
2
Handle webhook
When the envelope event will be triggered, the webhook will send a POST request to the specified URL. You can handle the request and perform the necessary actions on your end.
Example of a webhook payload:
ENVELOPE_DECLINED
{
"hook": {
"id": "6697ccb204bd194fa74c22b4",
"event": "envelope_declined",
"target": "https://webhook.site/47acfde3-bd83-4fbc-9ff1-ea0dc030e118"
},
"data": {
"id": "6697ccb204bd194fa74c22b4",
"uid": "4a6e29bfc5344ca6ad7cc8beda456481",
"envelope_id": "6697e681c5e364c7c23710d4",
"file_name": "dummy"
}
ENVELOPE_COMPLETED
{
"hook": {
"id": "6697ccb204bd194fa74c22b4",
"event": "envelope_completed",
"target": "https://webhook.site/47acfde3-bd83-4fbc-9ff1-ea0dc030e118"
},
"data": {
"id": "6697ccb204bd194fa74c22b4",
"uid": "4a6e29bfc5344ca6ad7cc8beda456481",
"envelope_id": "6697e681c5e364c7c23710d4",
"file_name": "dummy"
}
ENVELOPE_EXPIRED
{
"hook": {
"id": "6697ccb204bd194fa74c22b4",
"event": "envelope_expired",
"target": "https://webhook.site/47acfde3-bd83-4fbc-9ff1-ea0dc030e118"
},
"data": {
"id": "6697ccb204bd194fa74c22b4",
"uid": "4a6e29bfc5344ca6ad7cc8beda456481",
"envelope_id": "6697e681c5e364c7c23710d4",
"file_name": "dummy"
}
ENVELOPE_VOIDED
{
"hook": {
"id": "6697ccb204bd194fa74c22b4",
"event": "envelope_voided",
"target": "https://webhook.site/47acfde3-bd83-4fbc-9ff1-ea0dc030e118"
},
"data": {
"id": "6697ccb204bd194fa74c22b4",
"uid": "4a6e29bfc5344ca6ad7cc8beda456481",
"envelope_id": "6697e681c5e364c7c23710d4",
"file_name": "dummy"
}