Outgoing Webhooks Reference

Overview

The webhook request has following structure:

{
  "payload": "JSON ENCODED PAYLOAD",
}

You should first validate that the payload value signature matches the value provided in the x-webhook-signature header.

The encoded payload body has always this basic structure, with the payload field varying depending on the webhook event:

{
  "timestamp": "2024-01-01T20:00:00.000Z",
  "event": "event.name.here",
  "payload": { /* event-specific payload */ },
}

Events reference

session.booked

Triggered when any host session is booked by any way, including automatic or child bookings.

{
  "type": "object",
  "properties": {
    "sessionId": {
      "type": "integer",
      "description": "The ID of the booked session"
    },
    "sessionBookingId": {
      "type": "integer",
      "description": "The ID of the created session booking"
    },
    "payingMemberId": {
      "type": "integer",
      "description": "The ID of the member who paid for the session"
    },
    "targetMemberId": {
      "type": "integer",
      "description": "The ID of the member for whom the session was booked"
    }
  },
  "required": [
    "sessionId",
    "sessionBookingId",
    "payingMemberId",
    "targetMemberId"
  ]
}