Skip to main content
POST
Python

Authorizations

Authorization
string
header
required

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

Query Parameters

organization_id
string<uuid>

Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.

Body

application/json

Serializer for creating webhooks

name
string
required

User-friendly name for this webhook

Required string length: 1 - 255
url
string<uri>
required

Webhook endpoint URL

Required string length: 1 - 500
secret
string
Maximum string length: 255
headers
object

Custom headers to include in webhook requests (key-value pairs)

events
string[]

List of events to trigger this webhook (e.g., ['triggered'])

Minimum string length: 1
is_active
boolean
alerts
string<uuid>[]

Response

201 - application/json

Serializer for creating webhooks

name
string
required

User-friendly name for this webhook

Maximum string length: 255
url
string<uri>
required

Webhook endpoint URL

Maximum string length: 500
secret
string
Maximum string length: 255
headers
object

Custom headers to include in webhook requests (key-value pairs)

events
string[]

List of events to trigger this webhook (e.g., ['triggered'])

is_active
boolean
alerts
string<uuid>[]