Skip to main content
POST
/
v1
/
webhooks
/
endpoints
Create a webhook endpoint
curl --request POST \
  --url http://127.0.0.1:8787/v1/webhooks/endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhooks/kayle",
  "name": "<string>",
  "enabled": true,
  "subscribed_event_types": [
    "verification.attempt.succeeded"
  ]
}
'
{
  "data": {
    "endpoint": {
      "id": "<string>",
      "organization_id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "enabled": true,
      "subscribed_event_types": [
        "verification.attempt.succeeded"
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "disabled_at": "<string>"
    },
    "signing_secret": "<string>"
  },
  "error": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.kayle.id/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string
required

The URL of the webhook endpoint. Must use https:// (http:// is only accepted for localhost in development).

Example:

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

​
name
string

An optional display name for the webhook endpoint.

Required string length: 1 - 120
​
enabled
boolean

Whether the endpoint should be enabled immediately. Defaults to true.

​
subscribed_event_types
enum<string>[]

The event types this endpoint should receive.

Available options:
verification.attempt.succeeded,
verification.attempt.failed,
verification.session.expired,
verification.session.cancelled

Response

Successful operation.

​
data
object
required
​
error
object
required