Flipdish

Welcome to the Flipdish developer hub. You'll find comprehensive guides and documentation to help you start working with Flipdish as quickly as possible, as well as support if you get stuck. Let's jump right in!

> POS integration quick start guide
> Driver dispatch integration quick start guide

Store webhook events

store.created

Any time a store is created we can trigger a StoreCreatedEvent

Payload example:

{
  "EventName": "store.created",
  "StoreId": 1234,
  "User": {
    "UserId": 1234,
    "UserName": "JohnDoe",
    "UserPhoneNumber": "0818204488",
    "UserEmail": "[email protected]"
  },
  "Description": "1234 created a store",
  "FlipdishEventId": "1a92aaa3-59f4-4944-b868-a88cad0e291a",
  "CreateTime": "0001-01-01T00:00:00",
  "Position": 0
}

store.updated

Any time a store is updated we can trigger a StoreUpdatedEvent

Payload example:

{
  "EventName": "store.updated",
  "StoreId": 1234,
  "User": {
    "UserId": 1234,
    "UserName": "JohnDoe",
    "UserPhoneNumber": "0818204488",
    "UserEmail": "[email protected]"
  },
  "Description": "1234 updated store 1234",
  "FlipdishEventId": "1a92aaa3-59f4-4944-b868-a88cad0e291a",
  "CreateTime": "0001-01-01T00:00:00",
  "Position": 0
}

store.deleted

Any time a store is deleted we can trigger a StoreDeletedEvent

Payload example:

{
  "EventName": "store.deleted",
  "StoreId": 1234,
  "User": {
    "UserId": 1234,
    "UserName": "JohnDoe",
    "UserPhoneNumber": "0818204488",
    "UserEmail": "[email protected]"
  },
  "Description": "1234 updated store 1234",
  "FlipdishEventId": "1a92aaa3-59f4-4944-b868-a88cad0e291a",
  "CreateTime": "0001-01-01T00:00:00",
  "Position": 0
}

store.opening_hours.updated

Any time a store opening hours are updated we can trigger a StoreOpeningHoursUpdatedEvent

Payload example:

{
  "EventName": "store.opening_hours.updated",
  "StoreId": 1234,
  "User": {
    "UserId": 1234,
    "UserName": "JohnDoe",
    "UserPhoneNumber": "0818204488",
    "UserEmail": "[email protected]"
  },
  "Description": "1234 updated store opening hours",
  "FlipdishEventId": "1a92aaa3-59f4-4944-b868-a88cad0e291a",
  "CreateTime": "0001-01-01T00:00:00",
  "Position": 0
}

store.delivery_zone.updated

Any time a store delivery zone is updated we can trigger a StoreDeliveryZoneUpdatedEvent

Payload example:

{
  "EventName": "store.delivery_zone.updated",
  "StoreId": 1234,
  "User": {
    "UserId": 1234,
    "UserName": "JohnDoe",
    "UserPhoneNumber": "0818204488",
    "UserEmail": "[email protected]"
  },
  "Description": "1234 updated store delivery zone",
  "FlipdishEventId": "1a92aaa3-59f4-4944-b868-a88cad0e291a",
  "CreateTime": "0001-01-01T00:00:00",
  "Position": 0
}

Updated 2 years ago

Store webhook events


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.