Webhooks and its Data Formats
Introduction
Webhooks in BoloSign provide a mechanism for your application to receive real-time notifications about events such as new form responses, completed signatures, and new template responses. Understanding the data formats and how to test each webhook event is crucial for seamless integration and troubleshooting. This guide will walk you through the process of testing webhooks and understanding the data formats.
What Are BoloSign's Webhooks?
BoloSign offers several event triggers that you can receive through your application's webhooks, allowing you to customize and automate your action flows.
Event Triggers for BoloSign Webhooks
BoloSign provides the following event triggers for webhooks:
New Form Responses
New Signature Completed
New Template Response
Testing Each Webhook Event
After adding a webhook for any event, you can test whether your webhook URL is working. To do this, BoloSign will send sample data to your URL. When you click on “Test Webhook,” a modal will appear with the sample data that was sent to your URL, confirming the successful transmission of data.
The Data Format:
While Testing, you will receive the data as an array of objects, where each element of the array represents sample data for each document you have selected for that particular webhook & event.
Suppose, for your New Form Response event’s webhook you have chosen two forms ‘Test’ and ‘Zapier’, so while testing you will receive two objects inside the array, where each object represents each form’s sample data that you will receive when the event triggers.
You will receive this data when testing your webhook:
So while you are testing your URL you should keep that in mind, and you might consider testing your API (webhook URL) with one element at a time from the test response data
And this is what you will actually receives
Let us look at the actual data that will be sent for each Event.
New Form Response:
New Signature Completed
New Template Response
FAQs
What is a webhook in BoloSign? A webhook is a way for an application to provide real-time data to other applications. In BoloSign, webhooks notify you of events such as new form responses, completed signatures, and new template responses.
What data format is used for webhook events? Data is sent as an array of objects, where each object represents sample data for each document selected for the particular webhook and event.
Can I test my webhook with multiple documents? Yes, you can test your webhook with multiple documents. The test data will be sent as an array with each document's data as an individual object.
What should I do if my webhook test fails? Ensure that your webhook URL is correct and that your application can handle the incoming JSON data. Validate the structure and content of the data.
Conclusion
Testing webhooks in BoloSign ensures that your application can correctly handle real-time notifications for various events. By understanding the data formats and following these steps, you can effectively integrate and troubleshoot webhooks, ensuring a seamless and efficient workflow for your document processes.
Last updated