Booking Invite Opened

Webhook

POST

booking_invite.opened

Webhook Events

Last modified:2026-06-05 10:12:55

Maintainer:Not configured

Fired when a candidate visits the booking invite URL. This event may fire multiple times if the candidate opens the link more than once — handle idempotently.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Examples

Responses

🟢200

Return any 2xx status to acknowledge receipt.

This response does not have a body.

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://your-api-server.com' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event_id": "018f4a2b-5555-7000-8abc-def012345686",
    "event_type": "booking_invite.opened",
    "occurred_at": "2026-06-05T11:30:00+00:00",
    "data": {
        "invite_id": 101,
        "candidate_email": "jane.smith@nhsstaff.co.uk",
        "training_event_id": 26,
        "course_name": "CSTF All-In-One Mandatory Practical Training"
    }
}'

Modified at 2026-06-05 10:12:55

Booking Invite Sent

Booking Invite Used