Skip to main content
PATCH
Change a webhook endpoint: its `url` and `events` (both sent, as the form does) and, optionally, `enabled` to switch it off or on; the secret stays. Answers the endpoint.

Authorizations

Authorization
string
header
required

An account token from Settings › Account API in the Tawked console: Authorization: Bearer tk_acct_…

Headers

Idempotency-Key
string

One per intended change (1 to 128 printable ASCII characters): a retry with the same key and the same request answers the stored 2xx with Idempotent-Replayed: true, for 24 hours. A 428 approval_required is never stored: send the approved request again with the same key or none. An answer that carried a secret shown once is never kept: its replay answers 409 idempotency_secret_not_replayable with the id of what it made.

Required string length: 1 - 128

Path Parameters

application
string
required

An application's id (a UUID); list them with applications.applications.list.

Pattern: ^(?:[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})$
endpoint
string
required

A webhook endpoint's id (a UUID); list them with applications.webhooks.list.

Pattern: ^(?:[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})$

Body

application/json
events
enum<string>[]
required
Minimum array length: 1
Available options:
verification.verified,
verification.failed,
verification.expired,
message.sent,
message.delivered,
message.read,
message.failed,
email.delivered,
email.bounced,
email.complained,
email.failed
url
string
required
Maximum string length: 2048
enabled
boolean

Response

Done.

data
object
required