Create webhook endpoint
Register a new webhook endpoint. The URL must use HTTPS and must resolve to a public IP address. URLs pointing to private IP ranges (RFC 1918), loopback addresses, or link-local addresses are rejected to prevent SSRF attacks.
Requires an API key with write or admin scope.
The secret is returned only once on creation — store it securely.
Event types: policy.created, policy.updated, policy.retired, policy.codes_changed, policy.criteria_changed, or * for all.
Authorization
bearerAuth API keys are prefixed with vrt_live_ for production or vrt_test_ for testing.
Example: vrt_live_abc123xyz
In: header
Request Body
application/json
HTTPS URL to receive webhook deliveries
uriEvent types to subscribe to
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://verity.backworkai.com/api/v1/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "https://your-app.com/webhooks/verity", "events": [ "policy.created", "policy.updated" ] }'{
"success": true,
"data": {
"id": 0,
"url": "string",
"events": [
"string"
],
"status": "string",
"secret": "string",
"created_at": "2019-08-24T14:15:22Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}Last updated on