Webhooks Use Cases
Webhook functionality has been added to both audits and journeys. A webhook is a way to setup a notification system so that when ObservePoint servers have completed an audit or journey the user’s application is notified.
For those not familiar with webhooks, think of it this way: APIs allow you to retrieve information from a server while webhooks allow you to send a notification to a server upon the completion of an event. In this case, the event would be the completion of an audit or journey. Webhooks are often nicknamed “reverse API calls” because they send information rather than request it.
This is the basic workflow of how a webhook would function:
- Set up a server that receives POST requests and a URL for that server.
- Paste the URL into the webhook field of the audit or journey
- Upon completion of the audit or journey, a POST request is sent from ObservePoint using the URL you provided.
- The following JSON data is sent to your server:
"itemType": ["audit" | "web-journey" | "app-journey"],
"itemId": ["auditId" | "web-journeyId" | "app-journeyId"]
- The webhook triggers a script on your server to pull data from the recently completed audit or journey, based on the ID sent from the webhook.
- The data could then be sent via some sort of notification that you script.
The field to enter the Webhook URL is in Journey Setup for Journeys and under Advanced Setup for Audits.
The URL entered into the Webhook URL field must be an HTTP endpoint that can receive POST requests right after every run of an audit or journey completes.
The following are some use cases that webhooks can be used for. Setting up webhooks is a technical task that requires experience with coding.
- Upon completion of an audit/journey the webhook triggers a script to pull the page details report and send an email to the addresses in the notifications field of the recently completed audit/journey.
- Upon completion of an audit/journey the webhook triggers a script to pull a report from the recently completed audit/journey and display it in a dashboard.
- Integrate the Slack messaging app with your webhooks. Upon completion of the audit/journey your script is triggered to pull data such as rule failures or console errors. A webhook is also available on Slack and that is triggered as soon as the data is pulled and a message is sent to the relevant Slack channel.
- Integrate Jira with your webhooks. Upon completion of the audit/journey your script is triggered to pull data such as rule failures or console errors. This will then trigger the creation of a ticket in Jira.