Skip to main content
POST
/
webhooks
/
configure
Configure Webhook Endpoint
curl --request POST \
  --url https://api.urtentic.com/api/v1/webhooks/configure \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhooks/urtentic",
  "secret": "whsec_8fJ9LKps6YtG3xZD7N2W",
  "events": [
    "verification.completed",
    "verification.failed"
  ],
  "active": true
}
'
{
  "id": "wh_7dJ9LKps6YtG3xZD7N2W",
  "url": "https://example.com/webhooks/urtentic",
  "secret": "whsec_8fJ9LKps6YtG3xZD7N2W",
  "events": [
    "verification.completed",
    "verification.failed"
  ],
  "active": true,
  "createdAt": "2023-06-15T14:30:00Z"
}

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:
[
  "verification.completed",
  "verification.failed"
]
​
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:
[
  "verification.completed",
  "verification.failed"
]
​
active
boolean
Example:

true

​
createdAt
string<date-time>
Example:

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