Create a webhook endpoint

POST

/webhooks

Webhook Endpoints

Last modified:2026-06-03 19:01:51

Maintainer:Not configured

Registers a new HTTPS endpoint to receive booking lifecycle events.

Important: The signing secret is returned once only in the response. Store it securely — it cannot be retrieved again. If lost, use POST /webhooks/{id}/rotate-secret to generate a new one.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Webhook endpoint created. Secret shown once.

Bodyapplication/json

🟠401Unauthorized

🟠422ValidationError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/webhooks' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Production Booking Events",
    "url": "https://your-system.example.com/webhooks/bls",
    "events": [
        "booking.created",
        "booking.confirmed",
        "booking.attendance_marked",
        "booking.certificate_available"
    ],
    "timeout_seconds": 10,
    "is_active": true
}'

Response Example

201 - Success

{
    "id": 7,
    "name": "Production Booking Events",
    "url": "https://your-system.example.com/webhooks/bls",
    "events": [
        "booking.created",
        "booking.confirmed",
        "booking.attendance_marked",
        "booking.certificate_available"
    ],
    "secret": "aBcDeFgHiJkLmNoPqRsTuVwXyZ012345678901234567890123456789012345",
    "secret_prefix": "aBcDeFgHiJkL",
    "is_active": true,
    "created_at": "2026-06-03T18:00:00+00:00",
    "notice": "Store the secret securely — it will not be shown again."
}

Modified at 2026-06-03 19:01:51

List webhook endpoints

Get a webhook endpoint