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"
  ]
}

`session-booking-cancelled`

Triggered when a session booking is cancelled by either the member or the host.

{
  "type": "object",
  "properties": {
    "sessionBookingId": {
      "type": "integer",
      "description": "The ID of the cancelled session booking"
    },
    "sessionId": {
      "type": "integer",
      "description": "The ID of the session"
    },
    "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"
    },
    "isLateCancellation": {
      "type": "boolean",
      "description": "Whether this was a late cancellation"
    },
    "cancelledAt": {
      "type": "string",
      "description": "The timestamp when the booking was cancelled"
    }
  },
  "required": [
    "sessionBookingId",
    "sessionId",
    "payingMemberId",
    "targetMemberId",
    "isLateCancellation",
    "cancelledAt"
  ]
}

`member-assigned`

Triggered when a new member is assigned to a host.

{
  "type": "object",
  "properties": {
    "memberId": {
      "type": "integer"
    },
    "email": {
      "type": "string"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    }
  },
  "required": [
    "memberId",
    "email",
    "firstName",
    "lastName"
  ]
}

`member-updated`

Triggered when member attributes change.

{
  "type": "object",
  "properties": {
    "memberId": {
      "type": "integer"
    },
    "email": {
      "type": "string"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    }
  },
  "required": [
    "memberId",
    "email",
    "firstName",
    "lastName"
  ]
}

`member-address-created`

Triggered when a member address is created.

{
  "type": "object",
  "properties": {
    "memberAddressId": {
      "type": "integer"
    },
    "memberId": {
      "type": "integer"
    },
    "address": {
      "type": "string"
    },
    "zipcode": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "country": {
      "type": "string"
    }
  },
  "required": [
    "memberAddressId",
    "memberId",
    "address",
    "zipcode",
    "city",
    "country"
  ]
}

`member-address-updated`

Triggered when a member address is updated.

{
  "type": "object",
  "properties": {
    "memberAddressId": {
      "type": "integer"
    },
    "memberId": {
      "type": "integer"
    },
    "address": {
      "type": "string"
    },
    "zipcode": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "country": {
      "type": "string"
    }
  },
  "required": [
    "memberAddressId",
    "memberId",
    "address",
    "zipcode",
    "city",
    "country"
  ]
}

`member-address-deleted`

Triggered when a member address is deleted.

{
  "type": "object",
  "properties": {
    "memberAddressId": {
      "type": "integer"
    },
    "memberId": {
      "type": "integer"
    }
  },
  "required": [
    "memberAddressId",
    "memberId"
  ]
}

`session-created`

Triggered when any host session is created, including automatic or child sessions.

{
  "type": "object",
  "properties": {
    "sessionId": {
      "type": "integer",
      "description": "The ID of the created session"
    },
    "type": {
      "type": "string",
      "enum": [
        "private",
        "special-event",
        "special-event-new",
        "retreat",
        "fitness",
        "course",
        "course-class",
        "semester",
        "recital"
      ],
      "x-enumNames": [
        "PRIVATE",
        "SPECIAL_EVENT",
        "SPECIAL_EVENT_NEW",
        "RETREAT",
        "FITNESS",
        "COURSE",
        "COURSE_CLASS",
        "SEMESTER",
        "RECITAL"
      ]
    },
    "roomId": {
      "type": "integer",
      "nullable": true
    },
    "teacherId": {
      "type": "integer",
      "nullable": true
    },
    "payrateId": {
      "type": "integer",
      "nullable": true
    },
    "locationId": {
      "type": "integer",
      "nullable": true
    },
    "sessionTemplateId": {
      "type": "integer",
      "nullable": true,
      "description": "The ID of the session template from which the session was created, "
    },
    "sessionSemesterOccurrenceId": {
      "type": "integer",
      "nullable": true,
      "description": "The ID of the session semester occurrence, if this value is set it means that the session is part of a semester"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "startsAt": {
      "type": "string"
    },
    "endsAt": {
      "type": "string"
    },
    "capacity": {
      "type": "number",
      "nullable": true
    },
    "durationMinutes": {
      "type": "number",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "sessionId",
    "type",
    "roomId",
    "teacherId",
    "payrateId",
    "locationId",
    "sessionTemplateId",
    "sessionSemesterOccurrenceId",
    "name",
    "startsAt",
    "endsAt",
    "capacity",
    "durationMinutes",
    "description"
  ]
}

`session-updated`

Triggered when any host session is updated.

{
  "type": "object",
  "properties": {
    "sessionId": {
      "type": "integer",
      "description": "The ID of the updated session"
    },
    "type": {
      "type": "string",
      "enum": [
        "private",
        "special-event",
        "special-event-new",
        "retreat",
        "fitness",
        "course",
        "course-class",
        "semester",
        "recital"
      ],
      "x-enumNames": [
        "PRIVATE",
        "SPECIAL_EVENT",
        "SPECIAL_EVENT_NEW",
        "RETREAT",
        "FITNESS",
        "COURSE",
        "COURSE_CLASS",
        "SEMESTER",
        "RECITAL"
      ]
    },
    "roomId": {
      "type": "integer",
      "nullable": true
    },
    "teacherId": {
      "type": "integer",
      "nullable": true
    },
    "payrateId": {
      "type": "integer",
      "nullable": true
    },
    "locationId": {
      "type": "integer",
      "nullable": true
    },
    "sessionTemplateId": {
      "type": "integer",
      "nullable": true,
      "description": "The ID of the session template from which the session was created, "
    },
    "sessionSemesterOccurrenceId": {
      "type": "integer",
      "nullable": true,
      "description": "The ID of the session semester occurrence, if this value is set it means that the session is part of a semester"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "startsAt": {
      "type": "string"
    },
    "endsAt": {
      "type": "string"
    },
    "capacity": {
      "type": "number",
      "nullable": true
    },
    "durationMinutes": {
      "type": "number",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "sessionId",
    "type",
    "roomId",
    "teacherId",
    "payrateId",
    "locationId",
    "sessionTemplateId",
    "sessionSemesterOccurrenceId",
    "name",
    "startsAt",
    "endsAt",
    "capacity",
    "durationMinutes",
    "description"
  ]
}