Account Groups4

Account Settings9

Accounts16

Ad Accounts47

Ad Audiences7

Ad Campaigns50

Ad Creatives17

Ad Insights11

Ad Library1

Ad Targeting5

Analytics25

API Keys4

Blogs10

Broadcasts10

Business Agent55

Calls3

Comment Automations6

Comments15

Connect57

Connected Apps2

Contacts7

Conversions14

Custom Fields6

Discord24

GMB Attributes3

GMB Food Menus2

GMB Location Details2

GMB Media3

GMB Place Actions4

GMB Reviews5

GMB Services2

GMB Verifications4

iMessage17

Inbox Analytics7

Instagram5

Invites1

Lead Gen8

LinkedIn Mentions1

Logs1

Media1

Mentions2

Messages16

Messaging Ads3

Phone Numbers30

Posts10

Product Catalogs19

Products3

Profiles5

Queue6

Reach and Frequency4

Reddit Search2

Reviews3

Sequences10

Slack1

SMS22

Tools1

Tracking Tags10

Twitter Engagement8

Usage6

Users2

Validate4

Verify3

Voice18

Webhooks7

WhatsApp46

WhatsApp Calling16

WhatsApp Flows15

WhatsApp Phone Numbers16

WhatsApp Sandbox3

WhatsApp Templates1

Workflows14

Webhooks

Webhook Events55

Webhooks

Update webhook

Update an existing webhook configuration. All fields except webhookId are optional; only provided fields will be updated. webhookId is the same name the other /v1/webhooks operations use (logs, redeliver, test); the deprecated _id is still accepted in its place.

When provided, name must be 1-50 characters, url must be a valid URL, and events must contain at least one event. Whitespace is trimmed from url before validation.

Webhooks are auto-disabled only once the endpoint has had no successful delivery for 3 days AND has either reached 20 consecutive terminal failures (each one an event that exhausted the full retry ladder) or been failing continuously for 3 days. The owner is emailed; re-enable it with isActive: true.

A restricted (zrk_) API key can only set events to events whose resource group the key holds; an event outside the key's groups is rejected with 403. It also cannot widen an existing subscription past its own groups.

disabledResourceGroups replaces the subscription's own denylist, which applies to delivery regardless of which key or session created it. Send an empty array to clear it. A restricted key's own disabled groups are unioned into the stored value on every update, so repointing a legacy unrestricted subscription with a restricted key also narrows it.

Timing: the new denylist applies to every event emitted after the update. Events already queued for delivery when the update landed were filtered against the previous denylist and can still arrive at your endpoint for up to five minutes after they were enqueued, because the delivery worker trusts a five-minute enqueue-time snapshot before re-checking the subscription. Retries beyond that window, dead-letter replays, test fires, and redeliveries are all checked against the current denylist.

profileIds and accountIds replace the subscription's allowlists; an empty array clears one. Ids outside your team are rejected with 404 (profile_not_found, account_not_found).

put/v1/webhooks/settings

Request body

webhookIdstring

Webhook ID to update. Required unless the deprecated _id is sent instead.

_idstring

Alias of webhookId, kept for existing callers

namestring

Webhook name (1-50 characters). Must be non-empty if provided.

urlstring uri

Webhook endpoint URL (must be a valid URL, whitespace trimmed). Must be a valid URL if provided.

secretstring

Secret key for HMAC-SHA256 signature verification

eventsstring[]

Events to subscribe to. Must contain at least one event if provided.

isActiveboolean

Enable or disable webhook delivery

customHeadersobject

Custom headers to include in webhook requests

disabledResourceGroupsstring[]

Replaces the subscription's denylist. Send an empty array to clear it and receive every event in events again. Omitting the field leaves the current denylist untouched. Applies to events emitted after the update; already-queued events can still deliver for up to five minutes after they were enqueued. When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned back in either way, so a restricted key can neither clear nor widen a subscription past its own groups.

profileIdsstring[]

Replaces the subscription's profile allowlist. Send an empty array to receive every profile again. Omitting the field leaves the current list untouched. Every id must be a profile in your team, otherwise the request fails with 404 profile_not_found and nothing changes. Applies to events emitted after the update. Sending the stored list back unchanged is accepted without re-validation, so an endpoint stays editable after a listed profile is deleted.

accountIdsstring[]

Replaces the subscription's account allowlist. Send an empty array to receive every account again. Omitting the field leaves the current list untouched. Every id must be an account in your team, otherwise the request fails with 404 account_not_found and nothing changes. Sending the stored list back unchanged is accepted without re-validation.

Response

Webhook updated successfully

successboolean

Changes

Changed in 8 of the 56 revisions of this API.815

Sep 25, 20262c04683ce69422See the full diff
- ●
  added the new sms.registration.action_required enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new sms.registration.status_updated enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new sms.registration.action_required enum value to the request property /
  request-property-enum-value-added
- ○
  added the new sms.registration.status_updated enum value to the request property /
  request-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 25, 2026a0d8f21b5abe4See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 23, 2026dd3865482f9f3See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  the request property became optional
  request-property-became-optional
- ○
  request property deprecated
  request-property-deprecated
Sep 9, 202641eff0cffb2d11See the full diff
- ●
  added the new conversation.control_changed enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new conversation.control_changed enum value to the request property /
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 2, 20263f632ccead8811See the full diff
- ●
  added the new analytics.synced enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new analytics.synced enum value to the request property /
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 29, 2026e6f7a453bfb111See the full diff
- ●
  added the new phone_number.stock_available enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new phone_number.stock_available enum value to the request property /
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 25, 202644b6b1ca2a8b11See the full diff
- ●
  added the new whatsapp.account.name_status_updated enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new whatsapp.account.name_status_updated enum value to the request property /
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 20265b168c06d50522See the full diff
- ●
  added the new referral.received enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new whatsapp.template.category_updated enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new referral.received enum value to the request property /
  request-property-enum-value-added
- ○
  added the new whatsapp.template.category_updated enum value to the request property /
  request-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history