Available webhook types
Webhook This document describes the various webhook types available for interaction with external systems. Webhooks are triggered by specific events in the queue system, and each webhook type corresponds to different actions or changes within the system.
Webhook Types
Each webhook type is contained in “type” the type field in of the payload sent out to the destination URL. The receiving endpoint has to must appropriately handle the payload that is coming in incoming POST request accordinglypayload.
Webhook Type | Description |
|---|---|
positionCreated | Triggered when a walk- |
...
in or manual ticket is created. |
bookingConfirmation |
...
Triggered when a customer creates a new booking. | |
bookingActivated |
...
Triggered when a booking is activated (i.e., the timeslot |
...
becomes active). |
bookingUpdated |
...
positionRemoved - Staff rejected a ticket
...
Triggered when a booking is updated (e.g., rescheduled). | |
positionRemoved | Triggered when staff reject a ticket. |
positionRetry | Triggered when staff call retry on a ticket. |
positionCalled |
...
Triggered when staff call a position. | |
positionFulfilled |
...
positionCompleted - Staff checked-out position
...
positionCancelled - Customer cancelled position
...
positionCancelledByStaff - Staff cancelled upcoming booking
...
feedbackReceived - Customer updated feedback on ticket
Webhook payload
...
Triggered when staff check in a position. | |
positionCompleted | Triggered when staff check out a position. |
positionCancelled | Triggered when a customer cancels a position. |
positionCancelledByStaff | Triggered when staff cancel an upcoming booking. |
feedbackReceived | Triggered when a customer updates feedback on a ticket. |
Webhook Payload
Webhook payloads are sent in a POST request. The request supports headers configuration, for example for auth which can be used for authentication purposes.
Field |
|---|
...
Type | Description | |
|---|---|---|
message | string | Present for some |
...
webhook types |
...
; communicates a message to the customer associated with |
...
| Info |
|---|
Changelog 18-02-2021:
|
| Info |
|---|
Changelog 17-02-2021:
|
| Info |
|---|
Changelog 28-01-2021:
|
...
the event. |
data |
position - Position model current ticket or booking state
...
type - type of webhook, see above for full list
object | Contains detailed information about the event. |
Data Fields
Field | Type | Description |
|---|---|---|
position | object | Represents the current state of the ticket or booking (Position model). |
type | string | Type of the webhook, corresponding to the actions listed above. |
organization | string | Name of the organization to which the queue event corresponds. |
Position created webhook
| Code Block |
|---|
{
"message": null,
"data": {
"position": {
"status": "pending",
"priority": 0,
"location": {
"locationName": "Ombori Stress Test 1",
"organizationTitle": "Ombori Title"
},
"label": "A2",
"locale": "en",
"registrationData": {
"phone": { value: "+48888888888" },
},
"notification": {
"type": "phoneNumber",
"settings": {
"from": "",
"to": "+460000",
"recipient": ""
}
},
"id": "4f288ab1-72c9-402a-95b3-296766336b68",
"type": "anonymous",
"queue": "b23bea4f-8e8a-4da6-b413-04454f8428aa",
"createdAt": "2021-01-21T14:05:17.527Z"
}
},
"type": "positionCreated",
"organization": "ombori"
} |
...