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>",
  "labels": [
    "<string>"
  ],
  "enabled": true,
  "subscribed_event_types": [],
  "undelivered_payload_retention_hours": 72
}
'
{
  "data": {
    "endpoint": {
      "id": "<string>",
      "organization_id": "<string>",
      "name": "<string>",
      "labels": [
        "<string>"
      ],
      "url": "<string>",
      "enabled": true,
      "subscribed_event_types": [],
      "created_at": "<string>",
      "updated_at": "<string>",
      "disabled_at": "<string>",
      "undelivered_payload_retention_hours": 72
    },
    "signing_secret": "<string>"
  },
  "error": null
}

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).

Maximum string length: 2048
Example:

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

​
name
string

An optional display name for the webhook endpoint.

Required string length: 1 - 120
​
labels
string[]

Optional tag-style purpose labels for this endpoint.

Maximum array length: 8
​
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.session.succeeded,
verification.session.failed,
verification.session.expired,
verification.session.cancelled
​
undelivered_payload_retention_hours
default:72

How long Kayle should retain encrypted undelivered payloads after terminal delivery failure.

Available options:
0

Response

Successful operation.

​
data
object
required
​
error
null
required