Skip to main content

Event List

GoBiz supports various events to which the partner can subscribe to and receive notifications. When the subscribed events are triggered, the partner can receive specific notifications. You can find more information about how to subscribe to specific events in the Notification Subscriptions APIs.

note

The events are accessible to the partner as per the scopes defined in their API endpoints.

The events supported by GoBiz are described in the table given below.

NameDescription
gofood.order.awaiting_merchant_acceptanceThis event is triggered when the system is waiting for the merchant to accept the order.
Refer GoFood Awaiting Merchant Acceptance.
gofood.order.merchant_acceptedThis event is triggered when the merchant accepted new GoFood order.
Refer GoFood Merchant Accepted.
gofood.order.driver_otw_pickupThis event is triggered when the driver is on the way to the restaurant.
Refer GoFood Driver OTW Pickup.
gofood.order.driver_arrivedThis event is triggered when the driver arrives at the restaurant.
Refer GoFood Driver Arrived.
gofood.order.placedThis event is triggered when the driver received the food and transaction status is settled.
Refer GoFood Order Placed.
gofood.order.completedThis event is triggered when the order is completed.
Refer GoFood Order Completed.
gofood.order.cancelledThis event is triggered when the order is cancelled.
Refer GoFood Order Cancelled.
gofood.order.webhook_errorThis event is triggered when our system found unmet requirements during gofood.order.* webhook processing.
Refer GoFood Order Webhook Error
gofood.catalog.menu_mapping_updatedThis event is triggered when the menu mapping is done being processed by GoBiz.
Refer GoFood Menu Mapping Updated.
payment.transaction.settlementThis event is triggered when the payment transaction is completed.
Refer Payment Transaction Settlement.

GoFood Awaiting Merchant Acceptance Event

Code Sample
{
"header": {
"event_name": "gofood.order.awaiting_merchant_acceptance",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
},
"body": {
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "AWAITING_MERCHANT_ACCEPTANCE",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"applied_promotions": [
{
"scope": "sku",
"detail": {
"item": {
"id": "e91a3493-71c2-4ceb-9d87-4ab7794aab72",
"external_id": "F789315F-3ECA-4D31-983C-62ADD8E8325F"
},
"id": "b688aba2-ba96-4ed1-a241-56cedc7f022d"
}
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
}

This event triggered when an order starts to await the merchant to accept. Due to the nature of the internet network, there is no guarantee that the event will only be sent exactly once (e.g retry due to intermitten network). Thus, there might be a event duplication, and receiving end needs to be able to handle the duplication.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

Awaiting Merchant Acceptance Event - Header Parameters

Code Sample
{
"event_name": "gofood.order.awaiting_merchant_acceptance",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: gofood.order.awaiting_merchant_acceptanceStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which the event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

Awaiting Merchant Acceptance Event - Body Parameters

Code Sample
{
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "AWAITING_MERCHANT_ACCEPTANCE",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
JSON AttributeDescriptionTypeRequired
customerInformation about the customer.ObjectRequired
» idID of the customer.StringRequired
» nameCustomer name.StringRequired
driverInformation about the driver.ObjectRequired
» nameName of the driver.StringRequired
service_typeType of GoFood order. Possible Values: gofood, gofood_pickupStringRequired
outletDetails of the outlet.ObjectRequired
» idID of the outlet on GoBiz side.StringRequired
» external_outlet_idID of the outlet on partner side.StringRequired
orderDetails of the order.ObjectRequired
» statusStatus of the order. Value: AWAITING_MERCHANT_ACCEPTANCEStringRequired
» pinPersonal Identification Number for the verification of driver.StringRequired
» order_numberOrder number of the order.StringRequired
» order_totalTotal amount of the order.FloatRequired
» order_itemsDetails about the ordered items.Array(Object)Required
» applied_promotionsInformation about applied promos.Array(Object)Required
» cutlery_requestedBoolean value to indicate whether the customer requests cutlery.BooleanOptional
» currencyThree-letter alphabetic currency code as per ISO-4217 format. Value: IDRStringRequired
» takeaway_chargesTake-away charges of the order.FloatRequired
» created_atThe date and time at which order is created. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

GoFood Merchant Accepted Event

Code Sample
{
"header": {
"event_name": "gofood.order.merchant_accepted",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
},
"body": {
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "MERCHANT_ACCEPTED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"applied_promotions": [
{
"scope": "sku",
"detail": {
"item": {
"id": "e91a3493-71c2-4ceb-9d87-4ab7794aab72",
"external_id": "F789315F-3ECA-4D31-983C-62ADD8E8325F"
},
"id": "b688aba2-ba96-4ed1-a241-56cedc7f022d"
}
}
],
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
}

This event triggered when the merchant accepted an order. Due to the nature of the internet network, there is no guarantee that the event will only be sent exactly once (e.g retry due to intermitten network). Thus, there might be a event duplication, and receiving end needs to be able to handle the duplication.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

Merchant Accepted Event - Header Parameters

Code Sample
{
"event_name": "gofood.order.merchant_accepted",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: gofood.order.merchant_acceptedStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which the event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

Merchant Accepted Event - Body Parameters

Code Sample
{
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "MERCHANT_ACCEPTED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
JSON AttributeDescriptionTypeRequired
customerInformation about the customer.ObjectRequired
» idID of the customer.StringRequired
» nameCustomer name.StringRequired
driverInformation about the driver.ObjectRequired
» nameName of the driver.StringRequired
service_typeType of GoFood order. Possible Values: gofood, gofood_pickupStringRequired
outletDetails of the outlet.ObjectRequired
» idID of the outlet on GoBiz side.StringRequired
» external_outlet_idID of the outlet on partner side.StringRequired
orderDetails of the order.ObjectRequired
» statusStatus of the order. Value: MERCHANT_ACCEPTEDStringRequired
» pinPersonal Identification Number for the verification of driver.StringRequired
» order_numberOrder number of the order.StringRequired
» order_totalTotal amount of the order.FloatRequired
» order_itemsDetails about the ordered items.Array(Object)Required
» applied_promotionsInformation about applied promos.Array(Object)Required
» cutlery_requestedBoolean value to indicate whether the customer requests cutlery.BooleanOptional
» currencyThree-letter alphabetic currency code as per ISO-4217 format. Value: IDRStringRequired
» takeaway_chargesTake-away charges of the order.FloatRequired
» created_atThe date and time at which order is created. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

GoFood Driver Pickup Event

Code Sample
{
"header": {
"event_name": "gofood.order.driver_otw_pickup",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
},
"body": {
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "DRIVER_OTW_PICKUP",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"applied_promotions": [
{
"scope": "sku",
"detail": {
"item": {
"id": "e91a3493-71c2-4ceb-9d87-4ab7794aab72",
"external_id": "F789315F-3ECA-4D31-983C-62ADD8E8325F"
},
"id": "b688aba2-ba96-4ed1-a241-56cedc7f022d"
}
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
}

This event triggered when driver is on the way to the restaurant. Due to the nature of the internet network, there is no guarantee that the event will only be sent exactly once (e.g retry due to intermitten network). Thus, there might be a event duplication, and receiving end needs to be able to handle the duplication.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

Driver Pickup Event - Header Parameters

Code Sample
{
"event_name": "gofood.order.driver_otw_pickup",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: gofood.order.driver_otw_pickupStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which the event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

Driver Pickup Event - Body Parameters

Code Sample
{
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "DRIVER_OTW_PICKUP",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
JSON AttributeDescriptionTypeRequired
customerInformation about the customer.ObjectRequired
» idID of the customer.StringRequired
» nameCustomer name.StringRequired
driverInformation about the driver.ObjectRequired
» nameName of the driver.StringRequired
service_typeType of GoFood order. Possible Values: gofood, gofood_pickupStringRequired
outletDetails of the outlet.ObjectRequired
» idID of the outlet on GoBiz side.StringRequired
» external_outlet_idID of the outlet on partner side.StringRequired
orderDetails of the order.ObjectRequired
» statusStatus of the order. Value: DRIVER_OTW_PICKUPStringRequired
» pinPersonal Identification Number for the verification of driver.StringRequired
» order_numberOrder number of the order.StringRequired
» order_totalTotal amount of the order.FloatRequired
» order_itemsDetails about the ordered items.Array(Object)Required
» applied_promotionsInformation about applied promos.Array(Object)Required
» cutlery_requestedBoolean value to indicate whether the customer requests cutlery.BooleanOptional
» currencyThree-letter alphabetic currency code as per ISO-4217 format. Value: IDRStringRequired
» takeaway_chargesTake-away charges of the order.FloatRequired
» created_atThe date and time at which order is created. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

GoFood Driver Arrived Event

Code Sample
{
"header": {
"event_name": "gofood.order.driver_arrived",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
},
"body": {
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "DRIVER_ARRIVED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"applied_promotions": [
{
"scope": "sku",
"detail": {
"item": {
"id": "e91a3493-71c2-4ceb-9d87-4ab7794aab72",
"external_id": "F789315F-3ECA-4D31-983C-62ADD8E8325F"
},
"id": "b688aba2-ba96-4ed1-a241-56cedc7f022d"
}
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
}

This event triggered when driver arrived at the restaurant. Due to the nature of the internet network, there is no guarantee that the event will only be sent exactly once (e.g retry due to intermitten network). Thus, there might be a event duplication, and receiving end needs to be able to handle the duplication.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

Driver Arrived Event - Header Parameters

Code Sample
{
"event_name": "gofood.order.driver_arrived",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: gofood.order.driver_arrivedStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which the event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

Driver Arrived Event- Body Parameters

Code Sample
{
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "DRIVER_ARRIVED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
JSON AttributeDescriptionTypeRequired
customerInformation about the customer.ObjectRequired
» idID of the customer.StringRequired
» nameCustomer name.StringRequired
driverInformation about the driver.ObjectRequired
» nameName of the driver.StringRequired
service_typeType of GoFood order. Possible Values: gofood, gofood_pickupStringRequired
outletDetails of the outlet.ObjectRequired
» idID of the outlet on GoBiz side.StringRequired
» external_outlet_idID of the outlet on partner side.StringRequired
orderDetails of the order.ObjectRequired
» statusStatus of the order. Value: DRIVER_ARRIVEDStringRequired
» pinPersonal Identification Number for the verification of driver.StringRequired
» order_numberOrder number of the order.StringRequired
» order_totalTotal amount of the order.FloatRequired
» order_itemsDetails about the ordered items.Array(Object)Required
» applied_promotionsInformation about applied promos.Array(Object)Required
» cutlery_requestedBoolean value to indicate whether the customer requests cutlery.BooleanOptional
» currencyThree-letter alphabetic currency code as per ISO-4217 format. Value: IDRStringRequired
» takeaway_chargesTake-away charges of the order.FloatRequired
» created_atThe date and time at which order is created. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

GoFood Order Placed Event

Code Sample
{
"header": {
"event_name": "gofood.order.placed",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
},
"body": {
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "ORDER_PLACED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"applied_promotions": [
{
"scope": "sku",
"detail": {
"item": {
"id": "e91a3493-71c2-4ceb-9d87-4ab7794aab72",
"external_id": "F789315F-3ECA-4D31-983C-62ADD8E8325F"
},
"id": "b688aba2-ba96-4ed1-a241-56cedc7f022d"
}
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
}

This event is triggered when the driver receives the food and the transaction status is settled. Due to the nature of the internet network, there is no guarantee that the event will only be sent exactly once (e.g retry due to intermitten network). Thus, there might be a event duplication, and receiving end needs to be able to handle the duplication.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

Order Placed Event - Header Parameters

Code Sample
{
"event_name": "gofood.order.placed",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: gofood.order.placedStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which the event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

Order Placed Event - Body Parameters

Code Sample
{
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "ORDER_PLACED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
JSON AttributeDescriptionTypeRequired
customerInformation about the customer.ObjectRequired
» idID of the customer.StringRequired
» nameCustomer name.StringRequired
driverInformation about the driver.ObjectRequired
» nameName of the driver.StringRequired
service_typeType of GoFood order. Possible Values: gofoodStringRequired
outletDetails of the outlet.ObjectRequired
» idID of the outlet on GoBiz side.StringRequired
» external_outlet_idID of the outlet on partner side.StringRequired
orderDetails of the order.ObjectRequired
» statusStatus of the order. Value: ORDER_PLACEDStringRequired
» pinPersonal Identification Number for the verification of driver.StringRequired
» order_numberOrder number of the order.StringRequired
» order_totalTotal amount of the order.FloatRequired
» order_itemsDetails about the ordered items.Array(Object)Required
» applied_promotionsInformation about applied promos.Array(Object)Required
» cutlery_requestedBoolean value to indicate whether the customer requests cutlery.BooleanOptional
» currencyThree-letter alphabetic currency code as per ISO-4217 format. Value: IDRStringRequired
» takeaway_chargesTake-away charges of the order.FloatRequired
» created_atThe date and time at which order is created. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

GoFood Order Completed Event

Code Sample
{
"header": {
"event_name": "gofood.order.completed",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
},
"body": {
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "COMPLETED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"applied_promotions": [
{
"scope": "sku",
"detail": {
"item": {
"id": "e91a3493-71c2-4ceb-9d87-4ab7794aab72",
"external_id": "F789315F-3ECA-4D31-983C-62ADD8E8325F"
},
"id": "b688aba2-ba96-4ed1-a241-56cedc7f022d"
}
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
}

Triggered when the order has been completed. Due to the nature of the internet network, there is no guarantee that the event will only be sent exactly once (e.g retry due to intermitten network). Thus, there might be a event duplication, and receiving end needs to be able to handle the duplication.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

Order Completed Event - Header Parameters

Code Sample
{
"event_name": "gofood.order.completed",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: gofood.order.completedStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

Order Completed Event - Body Parameters

Code Sample
{
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "COMPLETED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
JSON AttributeDescriptionTypeRequired
customerInformation about the customer.ObjectRequired
» idID of the customer.StringRequired
» nameCustomer name.StringRequired
driverInformation about the driver.ObjectRequired
» nameName of the driver.StringRequired
service_typeType of GoFood order. Possible Values: gofood, gofood_pickupStringRequired
outletDetails of the outlet.ObjectRequired
» idID of the outlet on GoBiz side.StringRequired
» external_outlet_idID of the outlet on partner side.StringRequired
orderDetails of the order.ObjectRequired
» statusStatus of the order. Value: COMPLETEDStringRequired
» pinPersonal Identification Number for the verification of driver.StringRequired
» order_numberOrder number of the order.StringRequired
» order_totalTotal amount of the order.FloatRequired
» order_itemsDetails about the ordered items.Array(Object)Required
» applied_promotionsInformation about applied promos.Array(Object)Required
» cutlery_requestedBoolean value to indicate whether the customer requests cutlery.BooleanOptional
» currencyThree-letter alphabetic currency code as per ISO-4217 format. Value: IDRStringRequired
» takeaway_chargesTake-away charges of the order.FloatRequired
» created_atThe date and time at which order is created. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

GoFood Order Cancelled Event

Code Sample
{
"header": {
"event_name": "gofood.order.cancelled",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
},
"body": {
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "CANCELLED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"applied_promotions": [
{
"scope": "sku",
"detail": {
"item": {
"id": "e91a3493-71c2-4ceb-9d87-4ab7794aab72",
"external_id": "F789315F-3ECA-4D31-983C-62ADD8E8325F"
},
"id": "b688aba2-ba96-4ed1-a241-56cedc7f022d"
}
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
}

Triggered when the order got cancelled. Due to the nature of the internet network, there is no guarantee that the event will only be sent exactly once (e.g retry due to intermitten network). Thus, there might be a event duplication, and receiving end needs to be able to handle the duplication.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

Order Cancelled Event - Header Parameters

Code Sample
{
"event_name": "gofood.order.cancelled",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: gofood.order.cancelledStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

Order Cancelled Event - Body Parameters

Code Sample
{
"customer": {
"id": "536D5047BBBC0D5C7A51437C28CABCDE",
"name": "GoFood Customer"
},
"driver": {
"name": "GoFood Driver"
},
"service_type": "gofood",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"order": {
"status": "CANCELLED",
"pin": "1234",
"order_number": "F-123456789",
"order_total": 4.0e4,
"order_items": [
{
"quantity": 1,
"price": 1.5e4,
"notes": "pedas",
"name": "Hamburger",
"id": "e44495da-ebc2-493a-913a-b10d3a123456",
"external_id": "1773640",
"variants": [
{
"id": "e44495da-ebc2-493a-913a-b10d3a654321",
"name": "Hamburger keju",
"external_id": "11223344"
}
]
}
],
"cutlery_requested": true,
"currency": "IDR",
"takeaway_charges": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
JSON AttributeDescriptionTypeRequired
customerInformation about the customer.ObjectRequired
» idID of the customer.StringRequired
» nameCustomer name.StringRequired
driverInformation about the driver.ObjectRequired
» nameName of the driver.StringRequired
service_typeType of GoFood order. Possible Values: gofood, gofood_pickupStringRequired
outletDetails of the outlet.ObjectRequired
» idID of the outlet on GoBiz side.StringRequired
» external_outlet_idID of the outlet on partner side.StringRequired
orderDetails of the order.ObjectRequired
» statusStatus of the order. Value: CANCELLEDStringRequired
» pinPersonal Identification Number for the verification of driver.StringRequired
» order_numberOrder number of the order.StringRequired
» order_totalTotal amount of the order.FloatRequired
» order_itemsDetails about the ordered items.Array(Object)Required
» applied_promotionsInformation about applied promos.Array(Object)Required
» cutlery_requestedBoolean value to indicate whether the customer requests cutlery.BooleanOptional
» currencyThree-letter alphabetic currency code as per ISO-4217 format. Value: IDRStringRequired
» takeaway_chargesTake-away charges of the order.FloatRequired
» created_atThe date and time at which order is created. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

GoFood Order Webhook Error Event

Code Sample
{
"body": {
"error_type": "mapping_not_found",
"mapping_not_found": {
"items": [],
"variants": [
{
"name": "Paha atas"
},
{
"name": "Paha bawah"
}
]
},
"order": {
"number": "F-12345678"
},
"outlet": {
"external_outlet_id": "external-outlet-id",
"id": "G12345678"
}
},
"header": {
"event_type": "gofood.order.webhook_error",
"event_id": "67235bd0-c963-4c32-aca1-27a52ec963e5",
"version": 1,
"timestamp": "2023-03-29T14:15:22Z"
}
}

There's a possibility that the normal GoFood order webhook can't be sent due to unmet requirements (e.g. missing menu mapping). When that happened, this webhook will be sent instead.

This event triggered to notify partners when that case happened. Due to the nature of the internet network, there is no guarantee that the event will only be sent exactly once (e.g retry due to intermitten network). Thus, there might be a event duplication, and receiving end needs to be able to handle the duplication.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

Webhook Error Event - Header Parameters

Code Sample
{
"event_type": "gofood.order.webhook_error",
"event_id": "67235bd0-c963-4c32-aca1-27a52ec963e5",
"version": 1,
"timestamp": "2023-03-29T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: gofood.order.webhook_errorStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which the event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

Webhook Error Event - Body Parameters

Code Sample
{
"error_type": "mapping_not_found",
"mapping_not_found": {
"items": [
{
"name": "Fried chicken"
}
],
"variants": [
{
"name": "Paha atas"
},
{
"name": "Paha bawah"
}
]
},
"order": {
"number": "F-12345678"
},
"outlet": {
"external_outlet_id": "external-outlet-id",
"id": "G12345678"
}
}
JSON AttributeDescriptionTypeRequired
error_typeIndicating what kind of error causing webhook to be not sent. Values: mapping_not_found.StringRequired
orderInformation about related failing order webhook.ObjectRequired
» numberOrder number.StringRequired
outletInformation about related outlet.ObjectRequired
» idGoBiz Outlet identifier.StringRequired
» external_outlet_idPartner's outlet identifier.StringOptional
mapping_not_foundMore information about related error. In this case this field is required when error_type is mapping_not_found.ObjectRequired
» itemsInformation about missing mappings of items.ArrayRequired
» [] » nameInformation about missing item name.StringRequired
» variantsInformation about missing mappings of variants.ArrayRequired
» [] » nameInformation about missing variant name.RequiredRequired

GoFood Catalog Menu Mapping Event

Code Sample
{
"header": {
"event_name": "gofood.catalog.menu_mapping_updated",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
},
"body": {
"request_id": "string",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"menus": [
{
"id": "96f614f6-745e-47f5-ad68-c0c8e9ba8dc9",
"external_menu_id": "sample-abc-12345"
}
]
}
}

This event is triggered when the previous Menu Catalog Update process has been completed.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

GoFood Catalog Menu Mapping Event - Header Parameters

Code Sample
{
"event_name": "gofood.catalog.menu_mapping_updated",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: gofood.catalog.menu_mapping_updatedStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

GoFood Catalog Menu Mapping Event - Body Parameters

Code Sample
{
"request_id": "string",
"outlet": {
"id": "G123456789",
"external_outlet_id": "outlet01"
},
"menus": [
{
"id": "96f614f6-745e-47f5-ad68-c0c8e9ba8dc9",
"external_menu_id": "sample-abc-12345"
}
]
}
JSON AttributeDescriptionTypeRequired
request_idID of the request.StringRequired
outletDetails of the outlet.ObjectRequired
»idID of an outlet on GoBiz side.StringRequired
»external_outlet_idID of an outlet on partner side.StringRequired
menusDetails of the menu.Array(Object)Required
»idID of the menu on GoBiz side.StringRequired
»external_menu_idID of the menu on partner side.StringRequired

Transaction Settlement Event

Code Sample
{
"header": {
"event_name": "payment.transaction.settlement",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
},
"body": {
"outlet": {
"id": "G123456789"
},
"transaction": {
"id": "string",
"order_id": "string",
"settlement_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"currency": "IDR",
"gross_amount": 0,
"payment_type": "qris",
"status": "settlement",
"terminal_label": "string"
}
}
}

Triggered when the transaction got settled.

JSON AttributeDescriptionTypeRequired
headerDetails of the header object.ObjectRequired
bodyDetails of the body object.ObjectRequired

Transaction Settlement Event - Header Parameters

Code Sample
{
"event_name": "payment.transaction.settlement",
"event_id": "c1be7fa1-645e-3d57-9ca3-f2cb54212345",
"version": 1,
"timestamp": "2019-08-24T14:15:22Z"
}
JSON AttributeDescriptionTypeRequired
event_nameName of the event. Value: payment.transaction.settlementStringRequired
event_idID of the event.StringRequired
versionData structure version of the body parameter.IntegerRequired
timestampThe date and time at which event occurred. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired

Transaction Settlement Event - Body Parameters

Code Sample
{
"outlet": {
"id": "G123456789"
},
"transaction": {
"id": "string",
"order_id": "string",
"settlement_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"currency": "IDR",
"gross_amount": 0,
"payment_type": "qris",
"status": "settlement",
"terminal_label": "string"
}
}
JSON AttributeDescriptionTypeRequired
outletInformation about an outlet.ObjectRequired
» idID of an outlet.StringRequired
transactionDetails of the transaction.ObjectRequired
» idID of the transaction.StringRequired
» order_idID of the order.StringRequired
» settlement_atThe date and time at which transaction is successful. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired
» created_atThe date and time at which transaction is created. It is in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS±hh:mm).StringRequired
» currencyThree-letter alphabetic currency code as per ISO-4217 format. Value: IDRStringRequired
» gross_amountTotal amount of the transaction in IDR.IntegerRequired
» payment_typeType of payment method used. Value: QRISStringRequired
» statusStatus of the request. Value: settlementStringRequired