Skip to main content
POST
cURL

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new WebhookSubscription resource

name
string
required
Maximum string length: 255
url
string<uri>
required
eventTypes
(string | null)[]
required
secret
string | null
headers
(string | null)[] | null
isActive
boolean
default:true
maxRetries
integer
default:3
Required range: 0 <= x <= 10
timeoutSeconds
integer
default:30
Required range: 1 <= x <= 300
description
string | null
metadata
(string | null)[] | null

Response

WebhookSubscription resource created

name
string
required
Maximum string length: 255
url
string<uri>
required
eventTypes
(string | null)[]
required
id
integer
read-only
headers
(string | null)[] | null
isActive
boolean
default:true
maxRetries
integer
default:3
Required range: 0 <= x <= 10
timeoutSeconds
integer
default:30
Required range: 1 <= x <= 300
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

createdAt
string<date-time>
read-only
updatedAt
string<date-time> | null
read-only
lastTriggeredAt
string<date-time> | null
totalDeliveries
integer
default:0
read-only
successfulDeliveries
integer
default:0
read-only
failedDeliveries
integer
default:0
read-only
description
string | null
metadata
(string | null)[] | null