Skip to main content
POST
/
webhooks
Create Webhook record
curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://mijnklantportaal.nl/webhook-incoming",
  "type": "customer-created"
}'
{
  "id": "wbh_abc12345def678",
  "type": "customer-created",
  "url": "https://mijnklantportaal.nl/webhook-incoming",
  "secret": "OUJX2prdBbJxR77BZlGz",
  "createdAt": "2024-04-29T21:00:00+02:00"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string
required

The URL which needs to be called

Example:

"https://mijnklantportaal.nl/webhook-incoming"

​
type
string
required

Type of event what will trigger this webhook. Can be appointment-created, appointment-canceled, customer-created, customer-deleted, offer-created, offer-deleted, offer-accepted, offer-rejected, invoice-created, invoice-chargeback, invoice-paid, invoice-deleted, payment-link-created, payment-link-expired, payment-link-paid, ticket-created, ticket-reply-customer, ticket-reply-employee, subscription-created, subscription-updated, subscription-deleted, subscription-payment-created or subscription-payment-updated.

Example:

"customer-created"

Response

The created Webhook record

Webhook record

​
id
string

ID of the Webhook record, always starting with wbh_.

Example:

"wbh_abc12345def678"

​
type
string

Type of event what will trigger this webhook.

Example:

"customer-created"

​
url
string

The URL which gets triggered

Example:

"https://mijnklantportaal.nl/webhook-incoming"

​
secret
string

A random string which will be added to the X-Webhook-Signature header of the webhook call. With this secret, you can validate if the request is coming from MijnKlantportaal.

Example:

"OUJX2prdBbJxR77BZlGz"

​
createdAt
string

Date and time when the payment was started. Written in ATOM format.

Example:

"2024-04-29T21:00:00+02:00"

⌘I