Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Path Parameters

endpointId
string
required

Webhook endpoint id (ep_...).

Example:

"ep_2nJ4qKZr8C1tY0dXwV3uFh7bM9s"

Body

application/json
url
string
Maximum string length: 2048
description
string
Maximum string length: 500
eventTypes
string[] | null

Replaces the subscription. null subscribes to every event type.

Minimum array length: 1
enabled
boolean

Response

The updated endpoint.

id
string
required
Example:

"ep_2nJ4qKZr8C1tY0dXwV3uFh7bM9s"

url
string
required

As stored; the host may come back lowercased and a bare host with a trailing slash.

description
string
required
eventTypes
string[] | null
required

Subscribed event types, sorted. null means every event type, including ones added later.

status
enum<string>
required

disabled: turned off by you (Dashboard or API). failing: turned off automatically after repeated delivery failures; it may be re-enabled automatically, or by you.

Available options:
enabled,
disabled,
failing
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
secret
string

Only in the create response: the signing secret (whsec_...). Absent if it could not be read; then use the secret endpoint.