Skip to main content
POST
Configure Webhook Endpoint

Body

application/json
url
string<uri>
required

The HTTPS URL that will receive webhook notifications

Example:

"https://example.com/webhooks/urtentic"

secret
string

Secret key used to sign webhook payloads for verification. If not provided, a random secret will be generated.

Example:

"whsec_8fJ9LKps6YtG3xZD7N2W"

events
enum<string>[]

List of events to subscribe to. If empty, all events will be sent.

Available options:
verification.created,
verification.updated,
verification.completed,
verification.failed,
document.verified,
liveness.verified,
email.verified,
location.verified
Example:
active
boolean
default:true

Whether this webhook endpoint is active. Defaults to true.

Example:

true

Response

Webhook endpoint configured successfully

id
string

Unique identifier for the webhook configuration

Example:

"wh_7dJ9LKps6YtG3xZD7N2W"

url
string<uri>
Example:

"https://example.com/webhooks/urtentic"

secret
string
Example:

"whsec_8fJ9LKps6YtG3xZD7N2W"

events
string[]
Example:
active
boolean
Example:

true

createdAt
string<date-time>
Example:

"2023-06-15T14:30:00Z"