1. What is a Webhook
The Webhook feature allows our platform to send real-time notifications to your web applications and reporting systems. Once a webhook is activated, HTTP POST requests will start to be sent to a URL of your choice. Requests are in accordance with the completion of events generated via Widget, Lead Connect or API Integrations. Similarly to Call Reports. The URL for your web application can be updated and customised for your company. Requested data will be exported in JSON format.
2. How Webhooks Work
A Webhook can be created by registering the URL in the third-party application. In our case, ResponseiQ. Once a URL is registered, you can choose the event which will trigger a notification. These events will be active for both the Widget and the Lead Connect system.
The route created via webhooks holds the logic to be executed once an event is triggered. The system doesn't have to know the nature of what needs to be executed, it only needs to keep track of the routes to notify. It is a very powerful tool, as everything remains decoupled. Your web application will receive notifications through the chosen URL, not only does this know an event has occurred on our platform, but it can also react in response.
3. Events
Once an event has occurred across any of the platform's features, Widget, Lead Connect or API, JSON data will be sent in your Webhook URL. Below are listed examples of events and what has occurred to cause them:
4. Step by Step to Set-up a Webhook
4.1. Login to your company account on the ResponseiQ platform
4.2. From the menu go to Settings > Webhooks
4.3. Input your web application URL in the field “Webhook URL”. This should be the URL you want our platform to detect events for and send JSON data
4.4. Once ULR is completed, click on the button “Test” to check if the URL is returning a response. There are two possible responses:
4.4.1. Response 404: This return will alert that the URL you entered is not working and you might need to check the URL again
4.4.2. Response 200: This will depict that the URL is working and responding when the ResponseiQ platform registers a hit.
4.5. Once you are able to test the URL successfully, you can proceed to select Webhooks Format between “Form URL Encoded” or “JSON”
4.6 Once you are able to test the URL successfully, you can proceed to select Events. Only select the events you intend to use as triggers for the platform to send JSON data to your web application
4.7 Once you are done with selecting the events, just click on the “Save” button to activate the webhook for your web application. Note that if you have multiple domains/sub widgets you will need to complete this for each domain to ensure full coverage.
You should have now successfully activated the webhook for your Web Application with the ResponseiQ platform.
Tip: You can get the sample JSON data for each event using the “Read more” section given on the webhook setup screen
5. Webhook Logs
As multiple events will be triggered via the ResponseiQ widget over the registered web application URL. A webhook log is maintained by us on the platform.
The webhook Log will let you and your team be updated with all the call events that took place in accordance with the events you have selected previously. The log provides information among four columns – Response, Created, Event, Status.