This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
Location Connected Event
{
"data": {
"id": "c921703d-2367-4c47-afd8-ebddcb960116",
"merchantCode": "POS_TEST",
"name": "Plough Hotel",
"partnerLinks": {
"partnerCode": "ubereats",
"partnerLocationId": "00a580d7-83ae-4033-b65c-10c159f6b150",
"pausingOrders": true
},
"posBrand": "string",
"posLocationId": "2783bb07-f5f2-459d-8fe1-148c5b711d4c",
"webhookUrl": "string"
},
"location_id": "01HHRHV5CCETZY19NZEWYKB6MD.",
"timestamp": "2023-11-03T20:30:00.0Z",
"type": "location.connected"
}Location Disconnected Event
{
"data": {
"id": "2812cf8b-a8ab-4354-8c7e-a25a0122f777",
"merchantCode": "POS_TEST",
"name": "Plough Hotel",
"partnerLinks": {
"partnerCode": "ubereats",
"partnerLocationId": "00a580d7-83ae-4033-b65c-10c159f6b150",
"pausingOrders": true
},
"posBrand": "string",
"posLocationId": "2783bb07-f5f2-459d-8fe1-148c5b711d4c",
"webhookUrl": "string"
},
"location_id": "01HHRHV5CCETZY19NZEWYKB6MD.",
"timestamp": "2023-11-03T20:30:00.0Z",
"type": "location.connected"
}Location Update Event
{
"data": {
"id": "8014b574-fe53-45b0-8d21-82d422225e6f",
"merchantCode": "POS_TEST",
"name": "Plough Hotel",
"partnerLinks": {
"partnerCode": "ubereats",
"partnerLocationId": "00a580d7-83ae-4033-b65c-10c159f6b150",
"pausingOrders": true
},
"posBrand": "string",
"posLocationId": "2783bb07-f5f2-459d-8fe1-148c5b711d4c",
"webhookUrl": "string"
},
"location_id": "01HHRHV5CCETZY19NZEWYKB6MD.",
"timestamp": "2023-11-03T20:30:00.0Z",
"type": "location.connected"
}Partner is connected to Oolio Location on Reservations Portal
{
"isActive": true,
"partnerLocationId": "ahhzfnNldmVucm9vbXMtc2VjdXJlLWRlbW9y",
"posIdentifier": "oolio",
"posLocationId": "105f670d-c2b8-4d50-a839-982cf0b34ad6",
"posLocationName": "Reservation store 1",
"posOrganisationId": "857ce835-0cf1-4c27-9faa-0bbc6011e81e",
"posWebhookUrl": "https://nnncxa3hzj.execute-api.ap-southeast-1.amazonaws.com/test-in/webhook/oom/all"
}Partner is disconnected from Oolio Location on Reservations Portal
{
"isActive": false,
"partnerLocationId": "ahhzfnNldmVucm9vbXMtc2VjdXJlLWRlbW9y",
"posIdentifier": "oolio",
"posLocationId": "105f670d-c2b8-4d50-a839-982cf0b34ad6",
"posLocationName": "Reservation store 1",
"posOrganisationId": "857ce835-0cf1-4c27-9faa-0bbc6011e81e",
"posWebhookUrl": "https://nnncxa3hzj.execute-api.ap-southeast-1.amazonaws.com/test-in/webhook/oom/all"
}This event occurs when reservation is updated by partner (sevenrooms)
This event is created when walk-in reservation is created
Sent when an order is accepted
{
"data": {
"code": "#B52",
"consumer": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"notes": "string",
"postalCode": "string",
"state": "string"
},
"email": "jennifer@oolio.com",
"name": "Jennifer",
"notes": "string",
"phone": "string"
},
"createdAt": "2022-07-21T17:32:28Z",
"externalOrderRef": "11b969ea-2e4d-46ac-b727-3a7528e5306b",
"id": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"items": {
"includedItems": {
"name": "Salads",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "488dc695-73f6-4ce1-b143-231969ec4b27",
"productIds": {
"barcodes": "string",
"gtin-12": "123456789012",
"gtin-13": "1234567890123",
"gtin-14": "12345678901234",
"gtin-8": "12345678",
"plu": "1234",
"sku": "sku1234"
},
"quantity": 1,
"unitPrice": 200
},
"itemNotes": "string",
"measuredBy": {
"defaultSize": 1,
"unitType": "string",
"units": "string"
},
"name": "Scrambled Eggs",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"quantity": 1,
"status": "string",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"taxes": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"totalAfterSurcounts": 2000,
"totalBeforeSurcounts": 2000,
"type": "single",
"unitPrice": 800
},
"loyalty": {
"memberId": "string",
"redeemedRewards": {
"quantity": 1,
"rewardId": "string"
}
},
"notes": "extra hot",
"partner": "ubereats",
"partnerLocationId": "24343dc5-32fa-4002-ae2d-40f0b1e735cd",
"posDisplayId": "SP-20231001-101",
"posLocationId": "3be925ed-5f54-442f-9d45-e13613a261f1",
"rejectionReason": "string",
"requiredAt": "2022-07-21T18:32:28Z",
"reservation": {
"externalRef": "string"
},
"source": "pos",
"status": "accepted",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"table": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"name": "T-1",
"section": {}
}
}
}Order cancelled by the partner app
{
"data": {
"code": "#B52",
"consumer": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"notes": "string",
"postalCode": "string",
"state": "string"
},
"email": "jennifer@oolio.com",
"name": "Jennifer",
"notes": "string",
"phone": "string"
},
"createdAt": "2022-07-21T17:32:28Z",
"externalOrderRef": "11b969ea-2e4d-46ac-b727-3a7528e5306b",
"id": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"items": {
"includedItems": {
"name": "Salads",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "488dc695-73f6-4ce1-b143-231969ec4b27",
"productIds": {
"barcodes": "string",
"gtin-12": "123456789012",
"gtin-13": "1234567890123",
"gtin-14": "12345678901234",
"gtin-8": "12345678",
"plu": "1234",
"sku": "sku1234"
},
"quantity": 1,
"unitPrice": 200
},
"itemNotes": "string",
"measuredBy": {
"defaultSize": 1,
"unitType": "string",
"units": "string"
},
"name": "Scrambled Eggs",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"quantity": 1,
"status": "string",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"taxes": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"totalAfterSurcounts": 2000,
"totalBeforeSurcounts": 2000,
"type": "single",
"unitPrice": 800
},
"loyalty": {
"memberId": "string",
"redeemedRewards": {
"quantity": 1,
"rewardId": "string"
}
},
"notes": "extra hot",
"partner": "ubereats",
"partnerLocationId": "da9a29c8-4ce1-489a-b7f2-cc4cfc51808f",
"posDisplayId": "SP-20231001-101",
"posLocationId": "e1113b49-5042-4bdd-9884-34a0b30e7bc0",
"rejectionReason": "string",
"requiredAt": "2022-07-21T18:32:28Z",
"reservation": {
"externalRef": "string"
},
"source": "pos",
"status": "accepted",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"table": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"name": "T-1",
"section": {}
}
}
}Sent when an order is complete by pos system
{
"data": {
"code": "#B52",
"consumer": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"notes": "string",
"postalCode": "string",
"state": "string"
},
"email": "jennifer@oolio.com",
"name": "Jennifer",
"notes": "string",
"phone": "string"
},
"createdAt": "2022-07-21T17:32:28Z",
"externalOrderRef": "11b969ea-2e4d-46ac-b727-3a7528e5306b",
"id": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"items": {
"includedItems": {
"name": "Salads",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "488dc695-73f6-4ce1-b143-231969ec4b27",
"productIds": {
"barcodes": "string",
"gtin-12": "123456789012",
"gtin-13": "1234567890123",
"gtin-14": "12345678901234",
"gtin-8": "12345678",
"plu": "1234",
"sku": "sku1234"
},
"quantity": 1,
"unitPrice": 200
},
"itemNotes": "string",
"measuredBy": {
"defaultSize": 1,
"unitType": "string",
"units": "string"
},
"name": "Scrambled Eggs",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"quantity": 1,
"status": "string",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"taxes": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"totalAfterSurcounts": 2000,
"totalBeforeSurcounts": 2000,
"type": "single",
"unitPrice": 800
},
"loyalty": {
"memberId": "string",
"redeemedRewards": {
"quantity": 1,
"rewardId": "string"
}
},
"notes": "extra hot",
"partner": "ubereats",
"partnerLocationId": "a5e08132-88b8-4992-b7be-506b55ea4804",
"posDisplayId": "SP-20231001-101",
"posLocationId": "d9aeb7db-e8fb-451c-85d0-0ca8c7ffa5d3",
"rejectionReason": "string",
"requiredAt": "2022-07-21T18:32:28Z",
"reservation": {
"externalRef": "string"
},
"source": "pos",
"status": "accepted",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"table": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"name": "T-1",
"section": {}
}
}
}Sent when an order is created
{
"data": {
"code": "#B52",
"consumer": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"notes": "string",
"postalCode": "string",
"state": "string"
},
"email": "jennifer@oolio.com",
"name": "Jennifer",
"notes": "string",
"phone": "string"
},
"createdAt": "2022-07-21T17:32:28Z",
"externalOrderRef": "11b969ea-2e4d-46ac-b727-3a7528e5306b",
"id": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"items": {
"includedItems": {
"name": "Salads",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "488dc695-73f6-4ce1-b143-231969ec4b27",
"productIds": {
"barcodes": "string",
"gtin-12": "123456789012",
"gtin-13": "1234567890123",
"gtin-14": "12345678901234",
"gtin-8": "12345678",
"plu": "1234",
"sku": "sku1234"
},
"quantity": 1,
"unitPrice": 200
},
"itemNotes": "string",
"measuredBy": {
"defaultSize": 1,
"unitType": "string",
"units": "string"
},
"name": "Scrambled Eggs",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"quantity": 1,
"status": "string",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"taxes": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"totalAfterSurcounts": 2000,
"totalBeforeSurcounts": 2000,
"type": "single",
"unitPrice": 800
},
"loyalty": {
"memberId": "string",
"redeemedRewards": {
"quantity": 1,
"rewardId": "string"
}
},
"notes": "extra hot",
"partner": "ubereats",
"partnerLocationId": "8d386405-f4d1-48d7-8b3a-fc855efdfddc",
"posDisplayId": "SP-20231001-101",
"posLocationId": "03b5ea80-abdc-4110-9825-a0f62bff0324",
"rejectionReason": "string",
"requiredAt": "2022-07-21T18:32:28Z",
"reservation": {
"externalRef": "string"
},
"source": "pos",
"status": "accepted",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"table": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"name": "T-1",
"section": {}
}
}
}Order rejected by order-manager or by pos-brand
{
"data": {
"code": "#B52",
"consumer": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"notes": "string",
"postalCode": "string",
"state": "string"
},
"email": "jennifer@oolio.com",
"name": "Jennifer",
"notes": "string",
"phone": "string"
},
"createdAt": "2022-07-21T17:32:28Z",
"externalOrderRef": "11b969ea-2e4d-46ac-b727-3a7528e5306b",
"id": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"items": {
"includedItems": {
"name": "Salads",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "488dc695-73f6-4ce1-b143-231969ec4b27",
"productIds": {
"barcodes": "string",
"gtin-12": "123456789012",
"gtin-13": "1234567890123",
"gtin-14": "12345678901234",
"gtin-8": "12345678",
"plu": "1234",
"sku": "sku1234"
},
"quantity": 1,
"unitPrice": 200
},
"itemNotes": "string",
"measuredBy": {
"defaultSize": 1,
"unitType": "string",
"units": "string"
},
"name": "Scrambled Eggs",
"options": {
"max": 3,
"min": 1,
"name": "cooking type",
"posId": "c6eb09ce-3ce4-4f1d-91c4-523e73ca3aff",
"variants": {
"name": "Scrambled",
"posId": "627ddd31-8187-4914-b3b8-ab56b19aa2f4",
"price": 100,
"tax": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
}
}
},
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"quantity": 1,
"status": "string",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"taxes": {
"amount": 10,
"isTaxInclusive": true,
"name": "GST",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"totalAfterSurcounts": 2000,
"totalBeforeSurcounts": 2000,
"type": "single",
"unitPrice": 800
},
"loyalty": {
"memberId": "string",
"redeemedRewards": {
"quantity": 1,
"rewardId": "string"
}
},
"notes": "extra hot",
"partner": "ubereats",
"partnerLocationId": "966a43c3-0d2e-4409-9bcb-8ba690087eae",
"posDisplayId": "SP-20231001-101",
"posLocationId": "23bce5e5-638d-432b-b320-2ce8511bc888",
"rejectionReason": "string",
"requiredAt": "2022-07-21T18:32:28Z",
"reservation": {
"externalRef": "string"
},
"source": "pos",
"status": "accepted",
"surcounts": {
"amount": "10",
"name": "10% discount",
"posId": "91b969ea-2e4d-46ac-b727-3a7528e5306b",
"type": "percentage",
"value": 100
},
"table": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"name": "T-1",
"section": {}
}
}
}Listen products update item availability
{
"data": {
"posLocationId": "2783bb07-f5f2-459d-8fe1-148c5b711d4c"
},
"type": "products.availability"
}