Webhooks
What are Webhooks?
Webhooks are exactly like APIs - except they work in reverse. They send back data to the app which made the original API Call when a specific event occurs.
You know how when you shop online, you automatically get a message- when the order is placed, when the order is shipped and when the order is delivered? Webhooks are just like that.
They are automated messages/payloads, sent from a system to a unique URL. They are usually put in place for automatic delivery of information when an action is completed. This frees you from constantly having to seek updates.
And just like, to receive an update about the shipping of an order- you share a phone number or an email ID, for receiving a webhook response- you share a URL.
You can find the Webhook Documentation here.
Why should you use Webhooks?
A.
Increase efficiency: Using webhooks saves you from the effort of making repeated GET calls to get details again and again and hence saves time.
B.
Reduce load on your servers: It saves you from the effort of making repeated API Calls to Leegality for each action.
C.
Get notified instantly: If you use webhooks, we make the call to you as soon as a specific event takes place- you can sit back and relax.
D.
Reduce costs: Lowers operational costs by reducing the requirement for resources
E.
Enhance User Experience: Triggers quick responses for a smoother, more responsive experience
Leegality Webhooks and Response
You can use Webhooks to receive updates on the occurrence of success/failure events for each invitation in your eSign request API call. Depending on where you want the response, you can add a URL in the Workflow in the signing journey.
1.
On the dashboard, in invitee-level configurations, toggle on the “Add custom URLs and webhooks”
2.
In the field for webhook, insert the URL where you want to receive the webhook response.
3.
Whenever an invitee signs the document- you will get a response on this URL. There can be 2 types of responses.
4.
In the field for webhook, insert the URL where you want to receive the webhook response.
A.
Success: A call is made to the Webhook URL provided by you on every successful eSignature.
B.
Error: A call is made to the Webhook URL provided by you in case of authentication failures, attempt exhaustion,expiry of invitations and if the signer rejects the document.
5.
We receive a response for every successful webhook call. If we don’t receive a response then 3 re-attempts are made. The first, immediately, second, after an hour and the third after three hours.
Webhooks fallback - In API 3.3 make a GET call to check document details
If the Webhooks are not working for any reason, you can directly use the GET API to obtain data about the execution of the documents.
You need to call this API with the document ID to get the status of the transaction and/or to fetch the latest version of the document, and the Audit Trail if the document has been completed.
For more details on webhook calls and using GET API, refer to the API Documentation here.