Skip to main content
POST
Create 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.

Body

application/json

Request body of create_webhook.

name
string
required

Free text, 1..255 chars.

Required string length: 1 - 255
target_url
string
required

https only, a public host (no private or local address).

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

At least one catalog event type; exact membership.

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

Optional narrowing by sending identity.

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required