Skip to main content
POST
Create webhook.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
customId
string

Optional Id of webhook.

system
boolean

Creator of event will be set as System not requester.

proxy
boolean

Mark if proxy should be used with static outbound IP.

saveDetails
boolean

Save entire request.

maxAttempts
number

Max attempts.

request
object

Provide data

maskDetails
string[]

Mask request details.

createdBy
string

Override creator.

metadata
object

Optional key/value metadata for grouping and querying webhooks. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:
scheduleFor

Absolute delivery time as an ISO 8601 date-time string or Unix timestamp in milliseconds. Must not be in the past or more than 30 days in the future.

Response

Job scheduled.

Last modified on September 5, 2026