Skip to main content
PATCH
Update a webhook

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Webhook ID

Body

application/json
url
string
Maximum string length: 2083
Pattern: ^https?:\/\/
topics
string[]

Topic subscriptions: "*" (everything); "event.tracked" (all behavior events) or "event.tracked." for one; "content" / "content.published"; "user" or "user.created" / "user.updated" / "user.deleted"; "company" or "company.created" / "company.updated" / "company.deleted". A bare family name also covers topics added to it later. High-volume events (page_viewed) are excluded from the wildcard forms and must be subscribed explicitly.

Required array length: 1 - 100 elements
Required string length: 1 - 200
enabled
boolean
description
string
Maximum string length: 200

Response

Webhook updated

id
string
required
object
enum<string>
required
Available options:
webhook
createdAt
string
required
url
string
required
topics
string[]
required
enabled
boolean
required
description
string | null
required
consecutiveFailures
integer
required

Consecutive failed delivery attempts (circuit-breaker streak; any success resets).

Required range: -9007199254740991 <= x <= 9007199254740991
cooldownUntil
string | null
required

While in the future, deliveries to this endpoint are held and sent after the window (cooldown).

autoDisabledAt
string | null
required

Set when the system disabled the endpoint after sustained delivery failure.

secret
string

HMAC signing secret (whsec_...). Present only for tokens holding webhook:manage, and only on single-object reads, create, and rotate. An EMPTY string means the stored secret can no longer be decrypted (e.g. the encryption key changed) — call rotate-secret to mint a fresh one.