Webhooks allow external systems to receive real-time notifications from Visualogyx when certain events occur. When triggered, a POST request is sent to your specified endpoint URL with a structured payload.
Note: Webhooks are not enabled by default. To get access, contact us to request activation for your organization.
Supported Events
| Event Name | Description |
|---|---|
inspection.status.updated | Triggered when an inspection’s status is changed |
inspection.status.completed | Triggered when an inspection is marked complete |
How to Create a Webhook
- In the Web Application, go to Settings → Developer → Webhooks.
- Click Add Webhook.
- Fill in:
- Name – Internal name for the webhook
- Events – One or more supported events
- Endpoint – HTTPS URL to receive the webhook
Sample Payloads
inspection.status.updated`
{
"status_code": 200,
"event_payload": {
"event": "inspection.status.updated",
"timestamp": "2024-04-04T12:00:00Z",
"webhook": {
"id": "",
"name": "webhook name",
"url": "endpoint"
},
"metadata": "{\\\"IPAddress\\\": \\\"123.456.789.101\\\", \\\"Browser\\\":\\\"Chrome\\\", \\\"Referrer\\\":\\\"<https://example.com/signup>\\\"}",
"data": {
"type": "inspection",
"object": {
//Inspection object
}
}
}
}
inspection.status.completed`
{
"status_code": 200,
"event_payload": {
"event": "inspection.status.completed",
"timestamp": "2024-04-04T12:00:00Z",
"webhook": {
"id": "",
"name": "webhook name",
"url": "endpoint"
},
"metadata": "{\\\"IPAddress\\\": \\\"123.456.789.101\\\", \\\"Browser\\\":\\\"Chrome\\\", \\\"Referrer\\\":\\\"<https://example.com/signup>\\\"}",
"data": {
"type": "inspection",
"object": {
// Inspection object
}
}
}
}
Delivery & Retry Logic
If your endpoint is temporarily unavailable or does not respond with a 2xx status code, we will retry delivery a few times over a short interval. We do not currently support custom retry configuration or delivery status tracking.