Subscribe a webhook endpoint
POST
/v1/webhooksSubscribe an endpoint with an API key, for example from your own code or an automation platform. The URL follows the dashboard's rules (https, no private addresses). The signing secret is returned once. The organization's admins get the same security email as for an endpoint added in the dashboard. Without events, the endpoint receives verification.completed and verification.reviewed. At most 100 endpoints per organization. Needs the webhooks:manage scope.
Send your API key in the x-api-key header.
Request bodyapplication/jsonrequired
- urlstringuri≤ 2048 charsrequired
- eventsarray of string
- descriptionstring≤ 200 chars
Responses
201Subscribed.
- webhookobject
Show 6 child propertiesHide child properties
- idstringuuid
- urlstring
- descriptionstring
- eventsarray of string
- enabledboolean
- created_atstringdate-time
- secretstring
Shown once.
- 400Invalid body or a URL that is not allowed.
- 401Missing, unknown or expired API key.
- 403The key lacks the scope this call needs, or its IP allowlist refuses the caller.
- 409The organization already has 100 endpoints.
curl -X POST https://api-verify.secuveri.com/v1/webhooks \
-H "x-api-key: $SECUVERI_API_KEY" \
-H "content-type: application/json" \
-d '{
"url": "https://verify.secuveri.com/verification/VRF-7KQ2M9XA?t=…"
}'Response · 201
{
"webhook": {
"id": "0b8f4f5e-3c2a-4d1b-9e7f-6a5c4b3d2e1f",
"url": "https://verify.secuveri.com/verification/VRF-7KQ2M9XA?t=…",
"description": "<description>",
"events": [
"string"
],
"enabled": true,
"created_at": "2026-10-23T09:12:44.120Z"
},
"secret": "<secret>"
}