Skip to main content
POST
Create Webhook Endpoint

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Body

application/json
workspace_id
string<uuid>
required
url
string<uri>
required
Required string length: 1 - 2083
events
string[]

Event types to subscribe to. Empty = all.

description
string | null
Maximum string length: 512
active
boolean
default:true

Response

Successful Response

id
string<uuid>
required
workspace_id
string<uuid>
required
url
string
required
events
string[]
required
active
boolean
required
description
string | null
required
created_by
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
secret
string
required