Skip to main content
POST
Create Webhook Subscription

Authorizations

x-client-key
string
header
required
x-client-secret
string
header
required

Path Parameters

workspaceId
string<uuid>
required

Workspace ID

Body

application/json
name
string
required

Subscription name

Maximum string length: 255
url
string<uri>
required

HTTPS URL to receive webhooks

Maximum string length: 2048
events
string[]
required

Event types to subscribe to

Required array length: 1 - 50 elements
description
string

Optional description

Maximum string length: 2000
rateLimit
integer
default:100

Requests per minute limit

Required range: 1 <= x <= 1000
metadata
object

Custom key-value metadata

Response

Subscription created successfully

status
boolean
code
integer
data
object