Skip to content

Create Webhook

POST
/webhooks

Create a new webhook subscription. Returns the secret (only shown once).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
events
required

Event types to subscribe to

Array<string>
name
Any of:
string
url
required

Target URL for webhook delivery

string

Responses

201

Successful Response

object
data
required
object
created_at
Any of:
string
events
Array<string>
default:
id
required
string
is_active
boolean
default: true
name
Any of:
string
secret
Any of:
string
updated_at
Any of:
string
url
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string