Skip to main content

Embedded booking events

Subscribe to events from embedded booking calendars or booking pages to track visitor interactions and booking completions.

List of supported events​

Event nameFires when
oncehub.booking_calendar.loadedBooking calendar is first loaded, on page load.
oncehub.booking_calendar.time_slot_selectedVisitor selects a time slot and confirms it.
oncehub.booking.scheduledVisitor successfully completes the final step of the booking, and the meeting is scheduled.

Events payloads​

oncehub.booking_calendar.loaded​

Payload example:

{
  "type": "oncehub.booking_calendar.loaded",
  "payload": {
    "id": "BKC-LDJ878496X",
    "subject": "Meeting with Gilad Goraly",
    "host": "USR-HYPGJXN3A8",
    "url": "https://oncehub.com/gilad15",
    "name": "Gilad Goraly booking calendar",
    "duration_minutes": 30
  }
}

oncehub.booking_calendar.time_slot_selected​

Payload example:

{
  "type": "oncehub.booking_calendar.time_slot_selected",
  "payload": {
    "id": "BKC-LDJ878496X",
    "subject": "Meeting with Gilad Goraly",
    "host": "USR-HYPGJXN3A8",
    "url": "https://oncehub.com/gilad15",
    "name": "Gilad Goraly booking calendar",
    "duration_minutes": 30,
    "starting_time": "2020-03-22T04:30:00Z",
    "customer_timezone": "America/New_York"
  }
}

oncehub.booking.scheduled​

Payload example:

{
  "type": "oncehub.booking.scheduled",
  "payload": {
    "id": "BKNG-J4FR05BKEWEX",
    "subject": "Live demo",
    "status": "scheduled",
    "creation_time": "2020-03-22T09:48:48Z",
    "starting_time": "2020-03-22T04:30:00Z",
    "customer_timezone": "America/New_York",
    "host": "USR-FSD423423",
    "duration_minutes": 60,
    "location_description": "123 Office Street",
    "attendees": ["andrea.hartie@example.com", "carrie.customer@gmail.com"],
    "utm_params": {
      "source": "facebook",
      "medium": "social",
      "campaign": null,
      "term": null,
      "content": null
    },
    "ics_url": "https://oncehub.com/api/bookings/ics/62ad3bdd-a09f-dfbdffbef389-axs01j",
    "booking_calendar": "BKC-03WJV0R52Z",
    "cancel_url": "https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel",
    "reschedule_url": "https://oncehub.com/m/BKNG-3KM0HY2BF9SL",
    "custom_fields": [
      {
        "name": "discussion_points",
        "value": "Need support on new product"
      },
      {
        "name": "meeting_reason",
        "value": "Product demo"
      }
    ]
  }
}