Skip to main content
POST
Create webhook

Authorizations

x-api-key
string
header
required

Body

application/json

eventType and secret are not accepted on create/update: the server defaults eventType to GENERAL and generates the secret (both returned on the Webhook response).

name
string
required
url
string<uri>
required
description
string
headers
object
isActive
boolean

Response

201 - application/json

Webhook created. The response includes the signing secret — shown once, never returned again.

Returned by POST /webhooks only. Identical to Webhook plus the generated signing secret, which is shown once here and never again.

id
string
required
name
string
required
url
string<uri>
required
eventType
string
required

Defaults to GENERAL. Set server-side; not accepted on create/update.

isActive
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
secret
string
required

HMAC signing secret. Store it now — it is never returned again.

description
string
headers
object