Overview
Using webhooks, you can receive an HTTPS notification when your audits and journeys finish running. To use a webhook, you’ll need a web server on the internet that can receive HTTPS requests. ObservePoint can send a JSON payload to any HTTPS URL that you configure.
Configuring Webhooks
Each audit and journey can be configured to send a webhook request on completion. Webhook configuration is optional.
You have two options for configuring ObservePoint webhooks:
Option 1: Configure webhook destination via API
When you create a new audit or journey using a POST request, you can specify a webhook URL in the webHookUrl field:
For existing audits or journeys, you can assign a webhook URL to an existing audit or journey using the webHookUrl field in your PUT payload to these API endpoints:
Option 2: Configure webhook destination manually via app.observepoint.com
At app.observepoint.com, log in and navigate to the “data sources” page. Click the “edit” button on any audit or journey, enter the webhook URL, and click “Save”:
Webhook Payload
Upon completion of an audit or journey, ObservePoint will send the following payload to the URL you specified. ObservePoint sends the webhook whether the run is successful or not.
{
"itemId": auditId or web-journeyId,
"itemType": "audit" or "web-journey",
"runId": runId
}
Field Name | Field Description |
itemId | The ID of the audit or journey. |
runId | The run ID of the completed audit or journey run |
itemType | Tells you if the run is an “audit” or “web-journey” |
When you receive a webhook request, you can query the ObservePoint API to download results from the run using the itemId and runId.
Example Usages
The following are some use cases that webhooks can serve:
Upon completion of an audit or journey, the webhook triggers a script you write to pull the page details report and send an email to the addresses in the notifications field of the recently completed run.
Upon completion of an audit or journey, the webhook triggers a script to pull a report from the run and ingest the results into a BI system, like Tableau.
Integrate the Slack messaging app with your webhooks. Upon completion of an audit or journey, your script posts a message in your Slack channel to notify you about rule failures.
Integrate Jira with your webhooks. Upon completion of the audit or journey, your script is triggered to pull data such as rule failures or console errors. You can implement logic to create Jira tickets based on the results.