Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • positionCreated - Walk-in or manual ticket is created

  • bookingConfirmation - Customer created new booking

  • bookingActivated - Booking is activated (i.e. timeslot is active)

  • bookingUpdated - booking was updated (for example rescheduled)

  • positionRemoved - Staff rejected a ticket

  • positionRetry - Staff called retry on a ticket

  • positionCalled - Staff called a position

  • positionFulfilled - Staff checked-in position

  • positionCompleted - Staff checked-out position

  • positionCancelled - Customer cancelled position

  • positionCancelledByStaff - Staff cancelled upcoming booking

  • feedbackReceived - Customer updated feedback on ticket

...

  • message - present for some of webhook types, message that is communicated to customer associated with this event

  • data

  • type - type of webhook, see above for full list

  • organization - name of organization that this queue event corresponds to

Info

Changelog 17-02-2021:

  1. Added bookingUpdated webhook

Info

Changelog 28-01-2021:

  1. Updated position schema, please visit Position model

...

Code Block
{
  "message": "Your position: B1. Please come within 15 minutes to avoid cancellation of your appointment. Ticket: https://qr.run/1WPccolK",
  "data": {
    "position": {
      "location": {
        "locationName": "Ombori Stress Test 1"
      },
      "type": "booking",
      "priority": 100,
      "createdAt": "2021-01-21T14:08:44.038Z",
      "locale": "en",
      "registrationData": {
          "phone": { value: "+48888888888" },
      },
      "notification": {
        "type": "phoneNumber",
        "settings": {
          "from": "",
          "to": "",
          "recipient": ""
        }
      },
      "numberOfPeople": 1,
      "booking": {
        "start": "2021-01-21T14:10:00Z",
        "end": "2021-01-21T14:15:00Z",
        "virtualAppointment": {
          "isEnabled": false
        }
      },
      "status": "pending",
      "label": "B1",
      "id": "65e8eb52-7bba-4393-9a59-0b29c9251959",
      "queue": "b23bea4f-8e8a-4da6-b413-04454f8428aa",
      "bookingReminderAt": null,
      "fulfilledAt": "2021-01-21T14:10:00.479Z",
      "leaveReminderAt": null,
      "leaveAt": null
    }
  },
  "type": "bookingActivated",
  "organization": "ombori"
}

Booking updated webhook

Code Block
{
  "data": {
    "position": {
      "location": {
        "locationName": "Ombori Stress Test 1"
      },
      "type": "booking",
      "priority": 100,
      "createdAt": "2021-01-21T14:08:44.038Z",
      "locale": "en",
      "registrationData": {
          "phone": { value: "+48888888888" },
      },
      "notification": {
        "type": "phoneNumber",
        "settings": {
          "from": "",
          "to": "",
          "recipient": ""
        }
      },
      "numberOfPeople": 1,
      "booking": {
        "start": "2021-01-21T14:10:00Z",
        "end": "2021-01-21T14:15:00Z",
        "virtualAppointment": {
          "isEnabled": false
        }
      },
      "status": "pending",
      "label": "B1",
      "id": "65e8eb52-7bba-4393-9a59-0b29c9251959",
      "queue": "b23bea4f-8e8a-4da6-b413-04454f8428aa",
      "bookingReminderAt": null,
      "fulfilledAt": "2021-01-21T14:10:00.479Z",
      "leaveReminderAt": null,
      "leaveAt": null
    }
  },
  "type": "bookingUpdated",
  "organization": "ombori"
}

...