Skip to main content
POST
Create
Only name and webhook_url are required. The response includes the webhook_secretstore it now; it is never returned by any read endpoint. Creating a webhook never overrides an existing one; each tenant can hold up to 10.

Authorizations

api_key
string
header
required

Body

application/json
name
string
required
webhook_url
string<uri>
required
Required string length: 1 - 65536
headers
string[]
description
string
payload_format
enum<string>

An enumeration.

Available options:
json,
stringified_json

Response

Successful Response

This is base response model for all responses in partner service.

webhook_id
string
required
scope
WebhookScope · object
required
name
string
required
webhook_url
string
required
status
enum<string>
required

An enumeration.

Available options:
active,
disabled
created_at
string<date-time>
required
last_modified_time
string<date-time>
required
response_context
ResponseContext · object
required
webhook_secret
string
required
description
string
headers
string[]
payload_format
enum<string>

An enumeration.

Available options:
json,
stringified_json
legacy
boolean