Configure Webhook Endpoint
Configures a webhook endpoint to receive verification event notifications. This allows your application to receive real-time updates when verification statuses change.
Use Cases
- Setting up real-time verification notifications
- Configuring webhook endpoints for your application
- Specifying which events should trigger notifications
Notes
- This endpoint requires an API key with webhook configuration permissions
- The webhook URL must be publicly accessible and support HTTPS
- Webhooks are signed using a secret to verify authenticity
- Webhook requests will time out after 10 seconds
Body
The HTTPS URL that will receive webhook notifications
"https://example.com/webhooks/urtentic"
Secret key used to sign webhook payloads for verification. If not provided, a random secret will be generated.
"whsec_8fJ9LKps6YtG3xZD7N2W"
List of events to subscribe to. If empty, all events will be sent.
verification.created, verification.updated, verification.completed, verification.failed, document.verified, liveness.verified, email.verified, location.verified Whether this webhook endpoint is active. Defaults to true.
true
Response
Webhook endpoint configured successfully
Unique identifier for the webhook configuration
"wh_7dJ9LKps6YtG3xZD7N2W"
"https://example.com/webhooks/urtentic"
"whsec_8fJ9LKps6YtG3xZD7N2W"
true
"2023-06-15T14:30:00Z"