Skip to main content
PATCH
/
v1
/
webhooks
/
endpoints
/
{endpoint_id}
Update a webhook endpoint
curl --request PATCH \
  --url http://127.0.0.1:8787/v1/webhooks/endpoints/{endpoint_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "enabled": true,
  "subscribed_event_types": [
    "verification.attempt.succeeded"
  ]
}
'
{
  "data": {
    "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>"
  },
  "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.

Path Parameters

​
endpoint_id
string
required

The ID of the webhook endpoint to update (e.g. whe_...).

Body

application/json
​
name
string | null

Updated display name for the webhook endpoint.

Required string length: 1 - 120
​
url
string

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

​
enabled
boolean

New enabled state for the webhook endpoint.

​
subscribed_event_types
enum<string>[]

The updated event subscriptions for the endpoint.

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

Response

Successful operation.

​
data
object
required
​
error
object
required