Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

Authentication can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}.

Path Parameters

tenantId
string<uuid>
required

Id of the tenant

Body

application/json
name
string
required

Name of the webhook. Shown in the portal and on every delivery.

url
string<uri>
required

Public HTTP(S) address every delivery is POSTed to. Addresses on a private network are rejected.

events
string[]
required

Events to subscribe to, for example cases.create. Every event in the Webhooks reference can be subscribed to.

Minimum array length: 1
email
string<email> | null

Address notified when deliveries keep failing.

headers
object | null

Extra headers sent with every delivery, for example an authorization header the receiver expects.

deepFlattenBody
boolean

Flatten nested objects in the body into single level keys joined by "_", for receivers that cannot read nested JSON. Defaults to false.

pull
boolean

Hold deliveries for the webhook items endpoints instead of POSTing them. Defaults to false.

creditorId
string<uuid> | null

Scope the webhook to one creditor, so it only receives events for that creditor. Omit it for a tenant wide webhook.

Response

Successful operation

id
string<uuid>

Id of the webhook

name
string

Name of the webhook

url
string<uri>

Address every delivery is POSTed to

events
string[]

Events the webhook is subscribed to

creditorId
string<uuid> | null

Id of the creditor the webhook is scoped to. null is a tenant wide webhook that receives events for every creditor.

verificationToken
string<uuid>

Sent as the X-Verification-Token header on every delivery. Compare it with this value and reject requests that do not match.

email
string<email> | null

Address notified when deliveries keep failing. null when no address was given.

headers
object | null

Extra headers sent with every delivery

bodyMappers
object | null

Per event field maps that reshape the body before it is sent. null when the body is sent as it is.

deepFlattenBody
boolean

Whether nested objects in the body are flattened into single level keys joined by "_"

pull
boolean

Whether deliveries wait to be pulled through the webhook items endpoints instead of being POSTed

enabled
boolean

Whether the webhook is receiving events

createdAt
string<date-time>

When the webhook was created

createdBy
object | null

Who created the webhook