Skip to main content

Webhook - Model

KeyTypeValueDescription
uuidstringAJbtKpUMT6sfMocoA unique ID for the given webhook.
urlstringhttps://example.com/webhooksThe URL which webhooks will be sent to
secret_tokenstringsecretToken1The secret token passed in the Auth-Token header of every request
enabledbooleantrueWhether the webhook is enabled or not
eventsobject EventsHash of events
optionsOptions OptionsHash of options

Events

KeyTypeValueDescription
analytics_report_readybooleanfalsesend analytics report ready events
driver_eta_updatedbooleanfalsesend driver eta updated events
driver_location_updatedbooleanfalsesend driver location updated events
driver_shift_updatedbooleanfalsesend driver shift updated events
delivery_status_updatedbooleanfalsesend delivery status updated events
item_status_updatedobject ItemStatusUpdatedEventsend item status updated events
order_assignedbooleanfalsesend order assigned events
order_unassignedbooleanfalsesend order unassigned events
order_kds_print_requestbooleanfalsesend order kds print request events
order_status_updatedbooleanfalsesend order status updated events
order_preparation_updatedobject OrderPreparationUpdatedEventsend order preparation updated events

ItemStatusUpdatedEvent

KeyTypeValueDescription
suggestedbooleanfalsesend when status is suggested
being_preparedbooleanfalsesend when status is being_prepared
preparedbooleanfalsesend when status is prepared

OrderPreparationUpdatedEvent

KeyTypeValueDescription
suggestedbooleanfalsesend when status is suggested
being_preparedbooleanfalsesend when status is being_prepared
preparedbooleanfalsesend when status is prepared

Options

KeyTypeValueDescription
skip_unassigned_if_assigned_to_other_task_groupbooleanfalseskip unassigned event if the order was assigned to another task_group