Webhook - Model
Key | Type | Value | Description |
---|---|---|---|
uuid | string | AJbtKpUMT6sfMoco | A unique ID for the given webhook. |
url | string | https://example.com/webhooks | The URL which webhooks will be sent to |
secret_token | string | secretToken1 | The secret token passed in the Auth-Token header of every request |
enabled | boolean | true | Whether the webhook is enabled or not |
events | object Events | Hash of events | |
options | Options Options | Hash of options |
Events
Key | Type | Value | Description |
---|---|---|---|
analytics_report_ready | boolean | false | send analytics report ready events |
driver_eta_updated | boolean | false | send driver eta updated events |
driver_location_updated | boolean | false | send driver location updated events |
driver_shift_updated | boolean | false | send driver shift updated events |
delivery_status_updated | boolean | false | send delivery status updated events |
item_status_updated | object ItemStatusUpdatedEvent | send item status updated events | |
order_assigned | boolean | false | send order assigned events |
order_unassigned | boolean | false | send order unassigned events |
order_kds_print_request | boolean | false | send order kds print request events |
order_status_updated | boolean | false | send order status updated events |
order_preparation_updated | object OrderPreparationUpdatedEvent | send order preparation updated events |
ItemStatusUpdatedEvent
Key | Type | Value | Description |
---|---|---|---|
suggested | boolean | false | send when status is suggested |
being_prepared | boolean | false | send when status is being_prepared |
prepared | boolean | false | send when status is prepared |
OrderPreparationUpdatedEvent
Key | Type | Value | Description |
---|---|---|---|
suggested | boolean | false | send when status is suggested |
being_prepared | boolean | false | send when status is being_prepared |
prepared | boolean | false | send when status is prepared |
Options
Key | Type | Value | Description |
---|---|---|---|
skip_unassigned_if_assigned_to_other_task_group | boolean | false | skip unassigned event if the order was assigned to another task_group |