Skip to main content
POST
Create a webhook endpoint
Required scopes: metrics:webhooks.

Authorizations

x-chatobserver-key
string
header
required

A workspace API key. Data endpoints require a service-account key with the specified scopes.

Headers

Idempotency-Key
string
required

Unique key for one logical command. Reuse it only when retrying the same request and payload.

Required string length: 16 - 160
Pattern: ^[A-Za-z0-9:_-]+$

Body

application/json
name
string
required
Required string length: 3 - 120
url
string<uri>
required
Maximum string length: 2048
eventTypes
enum<string>[]
required
Minimum array length: 1
Available options:
metrics.query.created,
metrics.query.version_created,
metrics.query.published,
metrics.schedule.created,
metrics.schedule.version_created,
metrics.schedule.published,
metrics.schedule.paused,
metrics.schedule.resumed,
metrics.transfer.created,
metrics.transfer.version_created,
metrics.transfer.published,
metrics.transfer.paused,
metrics.transfer.resumed,
metrics.operation.accepted,
metrics.operation.cancel_requested,
metrics.operation.retried,
metrics.run.succeeded,
metrics.run.failed
description
null | string
Maximum string length: 2000

Response

Successful response.

data
object
required
replayed
required