Classroom & Events

The Event Webhook delivers an event payload any time a user registers for a Classroom or Event activity on a pathway. The payload contains an array of events in the data property and each event object contains a list of attendees that have registered (confirmed attendance).

Payload Example

{
  "type": "events",
  "data": {
    "pathway": {
      "name": "My Pathway",
      "ID": "FA-HCPG-06RF"
    },
    "events": [
      {
        "ID": "FABK-YVUU-89RU",
        "type": "event",
        "name": "Event",
        "start": "2020-10-15T16:15:00+02:00",
        "end": "2020-10-15T22:15:00+02:00",
        "venue": {
          "place": "Cable Car Station",
          "location": "Cape Town ZA"
        },
        "available": 4,
        "booked": 2,
        "attendees": [
          {
            "guid": "8bd0705f-c640-4191-9a1c-1a8cc73ad949",
            "state": "booked",
            "firstname": "Test",
            "lastname": "User",
            "email": "[e-mail]",
            "country": "South Africa",
            "city": "Cape Town"
          },
          ...etc
        ]
      },
      ...etc
    ]
  }
}

Key	Type
pathway	Object. The name and SKU of the related pathway.
events	Array. A list of events.

Event Object

Key	Type
ID	String. ID or SKU reference of the event.
name	String. Name of the event.
start	String. Start time of the event.
end	String. End time of the event.
venue	Object. Venue information.
booked	String. Number of registered attendees.
available	String. Available capacity (Unlimited or Number)
attendees	Array. A list of registered attendees.

Attendee Object

The attendee object will contain a guid which is used in the consume endpoint for events. This will allow integrations to set the booking state if the intention is to manage attendance of events via external systems.

Consume

Key	Type
guid	String. A GUID of the attendee.
state	String. The state of the attendance (booked, absent, attended).
firstname	String
lastname	String
email	String
country	String
city	String