Skip to main content
PATCH
Update webhook

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Webhook sid (wh_hk_...).

Required string length: 18
Pattern: ^wh_hk_

Body

application/json

Request body of update_webhook.

name
string

New name, 1..255 chars.

Required string length: 1 - 255
target_url
string

https only, a public host; unique per team.

Maximum string length: 2048
events
enum<string>[]

FULL replacement of the subscribed types.

Minimum array length: 1
Available options:
data-sources.completed,
data-sources.failed,
data-sources.paused,
data-sources.deleted,
playtable-runs.finished,
playtable-runs.cancelled,
workflows.published,
workflow-records.entered,
workflow-records.completed,
workflow-records.failed,
workflow-records.exited,
workflow-records.paused,
workflow-records.resumed,
messages.sent,
messages.received,
messages.bounced,
conversations.created,
conversations.state-changed,
conversations.scenario-changed,
conversations.merged,
conversations.person-linked,
conversations.person-unlinked,
conversations.signals-changed,
tasks.created,
tasks.completed,
sender-profiles.created,
sender-profiles.deleted,
sender-profiles.health-changed,
agents.mode-changed,
signals.website-visited,
website-sites.broken,
website-sites.recovered,
webhooks.failed
filters
object

FULL replacement; {} or account_sid null clears the narrowing.

status
enum<string>

on | off; failed is platform-set.

Available options:
on,
off

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.