Create Webhook

POST

/webhooks

• Production
• QA

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

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

object

environment

Any of:

string

string

Allowed values: live sandbox

null

null

events

required

Event types to subscribe to

Array<string>

field_filters

Any of:

object

object

key

additional properties

Array<string>

null

null

name

Any of:

string

string

null

null

url

required

Target URL for webhook delivery

string

Responses

201

Successful Response

object

data

required

object

created_at

Any of:

string

string

null

null

environment

‘live’ or ‘sandbox’: which events this subscription receives.

string

default: live

events

Array<string>

default:

field_filters

Any of:

object

object

key

additional properties

Array<string>

null

null

id

required

string

is_active

boolean

default: true

name

Any of:

string

string

null

null

secret

Any of:

string

string

null

null

updated_at

Any of:

string

string

null

null

url

required

string

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string