📖 Table of contents
What is a Webhook?
To begin with, what is a Webhook?
With Webhooks, you can be notified of events concerning the signing of your documents directly from the solutions or tools in which you have integrated the API.
In concrete terms, Webhooks allow you to automate your actions around signing, such as automatically downloading documents after they have been signed, or displaying in a third-party tool that a document has been signed on Yousign.
How do I access Webhooks from the Application?
Go to your menu, then choose "Developers", and click on "Webhooks".
If this is your first Webhook, the interface will ask you to create your first Webhook. If you already have active Webhooks, they will be listed in the interface. Just click on a Webhook to get the details.
How to create a Webhook?
On the interface of the application dedicated to Webhooks click on "Create a Webhook".
The first button allows you to immediately activate, or deactivate, the Webhook you are about to create.
3 steps are then necessary to create a Webhook:
Start by entering the URL for the End-point.
This is the destination address of the Webhook to which you want to send the event concerned by the Webhook.
This address should start with "https://"
You can also add a brief description of the Webhook, explaining why you are creating it. This is not necessary for the Webhook to work, but the information will be included.
Then select the environment of the Webhook. You can choose between :
Sandbox : The API test environment, you can test the Webhook before integrating it into production
Production : The environment on which your integration is live.
Finally, choose the events that will trigger your Webhook. You can choose to select all the events listed, or select the desired events one by one manually. Choose as many as you need.
3 types of events are available :
1. Events related to the signature invitation
signature_request.activatedwhen the status of the signature invitation changes from "draft" to "in progress
signature_request.donewhen all signatories have signed the document
signature_request.expiredwhen the signature invitation has expired
signature_request.reminder_executedwhen a reminder has been sent to the signatory to invite him to sign
2. Signer-related events
signer.notifieda specific signatory can now sign
signer.link_openeda specific signer has opened the link of the signature invitation
signer.donea specific signatory has signed the document
3. Contract events
contact.createda contact has been created (except for contacts from a CSV import)
Finalise by clicking on "Create a Webhook" ! You will then be able to track or modify your webhook from the webhook tracking interface.
