What are Xodo Sign API webhooks?
Webhooks are a valuable tool for automating certain processes in Xodo Sign API. By setting up webhooks, you can receive real-time notifications about specific events that occur within your Xodo Sign account. For instance, if you want to receive a notification every time a document is signed, you can set up a webhook to receive a message with relevant information as soon as the event takes place, making it easier to stay on top of important information.
Whether you want to be notified about when the document is signed, completed, deleted, declined, or even expired, webhooks have you covered. In this article, we will further explain how to set up webhooks and what kind of events you can be notified about.
Setting up webhooks
To set up a webhook in Xodo Sign API, you will need to do the following:
- Identify the event you want to receive notifications for. There are several events you can choose from, which are presented below in the Callbacks section.
- Determine the URL where you want to receive the notifications.
- Configure the webhook in Xodo Sign API. This involves providing the URL from step 2 and selecting the event from step 1.
There are two types of event callbacks that can be posted to the Webhook URLs you specify: Account-based callbacks and App-based callbacks. When an event occurs that you have set up a webhook for, Xodo Sign API will send a message to the specified URL with the relevant information. The message will be in the form of a POST request with a JSON body.
🔁 Webhook retry interval
When you receive an Xodo Sign event, your endpoint should return an HTTP 200 status code indicating that the event has been successfully received. Webhooks are automatically retried for up to 24 hours if no HTTP 200 status code is returned. The retry intervals are 1, 10, 60, 120, 240, and 480 minutes ending with the last retry after 24 hours.
Xodo Sign API provides several different events that you can receive notifications about. Below you can see a table showing all available document events:
If you would like to learn more about using webhooks with Xodo Sign API, be sure to check out our API documentation for more information.