HomeGuidesAPI Reference

Webhook events

A webhook delivers data to other applications as it happens, meaning you get data immediately.

Suggest Edits

Available webhook events

NameDescriptionModel Reference
customer.consent.updatedAny time a customer opt in or outCustomerConsentUpdatedEvent
customer.createdAny time a customer is createdCustomerCreatedEvent
customer.updatedAny time a customer is updatedCustomerUpdatedEvent
menu.createdAny time a menu is createdMenuCreatedEvent
menu.updatedAny time a menu is updatedMenuUpdatedEvent
order.acceptedAny time an order is acceptedOrderAcceptedEvent
order.createdAny time an order is createdOrderCreatedEvent
order.rating.updatedAny time an order rating is updatedOrderRatingUpdatedEvent
order.refundedAny time an order is refundedOrderRefundedEvent
order.rejectedAny time an order is rejectedOrderRejectedEvent
order.tip.updatedAny time an order tip is updatedOrderTipUpdatedEvent
store.createdAny time a store createdStoreCreatedEvent
store.updatedAny time a store updatedStoreUpdatedEvent
store.deletedAny time a store deletedStoreDeletedEvent
store.opening_hours.updatedAny time a store opening hours are updatedStoreOpeningHoursUpdatedEvent
store.opening_hours.updatedAny time a store delivery zone is updatedStoreDeliveryZoneUpdatedEvent
webhook_subscription.createdAny time a webhook subscription is createdWebhookSubscriptionCreatedEvent
webhook_subscription.deletedAny time a webhook subscription is deletedWebhookSubscriptionDeletedEvent
webhook_subscription.updatedAny time a webhook subscription is updatedWebhookSubscriptionUpdatedEvent

📘

We are continuously working on extending our webhook event repertoire.

Updated about 5 years ago