WebHook (POSTBack)
Webhooks (POSTBack)
A webhook is a method of receiving information when an event occurs. In practice, the webhook is a way to receive information between two systems in a passive manner.
At D4Sign, when a document is signed by a signatory, finalized or canceled — that is, reaches the FINISHED or CANCELED status — we will trigger an HTTP POST event to the URL provided in the document.
Additionally, when an email is not delivered to the signatory, we will also trigger an HTTP POST event to the URL provided in the document.
The event that triggers the WEBHOOK occurs only when the document is signed by one of the parties, is finalized or canceled, and also when an email is not delivered to the registered signatory.
The trigger occurs in FORM-DATA format.
Responses sent to your URL via POST
{
"uuid": "UUID-DOCUMENT",
"type_post": "1",
"message": "Finished document"
}
{
"uuid": "UUID-DOCUMENT",
"type_post": "3",
"message": "Cancelled document"
}
{
"uuid": "UUID-DOCUMENT",
"type_post": "2",
"message": "E-mail not sent",
"email": "[email protected]"
}
{
"uuid": "UUID-DOCUMENT",
"type_post": "4",
"message": "Signed",
"email": "[email protected]"
}
ATENÇÃO: IMPORTANT: We recommend using http://requestcatcher.com/ for testing purposes. These services provide a URL that captures HTTP requests and displays them in a user-friendly way.
Retry Attempts
If the URL registered in the document is unavailable, the system will attempt up to 6 additional requests, as outlined below:
Attempt 1: 0 min.
Attempt 2: after 1 hour.
Attempt 3: after 1 hour.
Attempt 4: after 1 hour.
Attempt 5: after 6 hours.
Attempt 6: after 6 hours.
Attempt 7: after 12 hours.
Therefore, the webhook will only be lost if the registered URL remains unavailable for more than 27 hours.
Updated about 2 months ago