Register webhook URL

POST

/baas/Webhooks/subscription

Sets the URL that receives all webhooks of your integration. Only one URL is registered at a time: calling the
endpoint again replaces it, and later deliveries, including retries, go to the new URL. The URL must be
absolute; use https. The response contains the registered subscription.

Each webhook is an HTTP POST with a JSON body containing id, type and payload, and the headers
X-Webhook-Id, X-Webhook-Timestamp (Unix time, seconds) and X-Webhook-Signature. The signature is the
lowercase hexadecimal HMAC-SHA256 of {timestamp}.{body}, computed with the signing secret issued to you
separately. Verify it before processing a webhook. Respond with any 2xx status to confirm receipt.

Webhooks raised while no URL was registered are not sent after registration; find them with
GET /baas/Webhooks and resend them with POST /baas/Webhooks/{id}/retry.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/json

Example

{
    "url": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/baas/Webhooks/subscription' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "string"
}'

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "url": "string"
}

🟠400

🟠404

🟠422

🔴500

Modified at 2026-09-29 12:10:42

Get transfer

Get webhook URL