Flipdish · JSON Structure

Platform External Store Event Structure

External event

Type: object Properties: 22

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

ExternalStoreEvent is a JSON Structure definition published by Flipdish, describing 22 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

EventName StoreId User Description DescriptionFormat DescriptionFields DescriptionId Ref1 Ref2 Ref3 Ref4 OrderId Tags FieldChanges FlipdishEventId CreateTime Position AppId OrgId IpAddress ActivityId ActivityType

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/platform-external-store-event-structure.json",
  "name": "ExternalStoreEvent",
  "description": "External event",
  "type": "object",
  "properties": {
    "EventName": {
      "description": "The event name",
      "type": "string",
      "example": "Example Name"
    },
    "StoreId": {
      "description": "Store Id",
      "type": "int32",
      "example": 500123
    },
    "User": {
      "$ref": "#/components/schemas/UserEventInfo"
    },
    "Description": {
      "description": "Description",
      "type": "string",
      "example": "string"
    },
    "DescriptionFormat": {
      "description": "Description with format placeholders",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "DescriptionFields": {
      "description": "Description with format placeholders",
      "type": "string",
      "example": "string"
    },
    "DescriptionId": {
      "description": "Description",
      "type": "string",
      "example": "500123"
    },
    "Ref1": {
      "description": "Ref (reference field)",
      "type": "string",
      "example": "string"
    },
    "Ref2": {
      "description": "Ref2 (reference field)",
      "type": "string",
      "example": "string"
    },
    "Ref3": {
      "description": "Ref3 (reference field)",
      "type": "string",
      "example": "string"
    },
    "Ref4": {
      "description": "Ref4 (reference field)",
      "type": "string",
      "example": "string"
    },
    "OrderId": {
      "description": "Order Id",
      "type": "int32",
      "nullable": true,
      "example": 500123
    },
    "Tags": {
      "description": "Tags",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "string"
      ]
    },
    "FieldChanges": {
      "description": "Field changes list",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FieldChangeInformation"
      },
      "example": []
    },
    "FlipdishEventId": {
      "description": "The identitfier of the event",
      "type": "uuid",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "CreateTime": {
      "description": "The time of creation of the event",
      "type": "datetime",
      "example": "2026-06-02T12:00:00Z"
    },
    "Position": {
      "description": "Position",
      "type": "int32",
      "example": 1
    },
    "AppId": {
      "description": "App id",
      "type": "string",
      "example": "500123"
    },
    "OrgId": {
      "description": "Org id",
      "type": "string",
      "example": "500123"
    },
    "IpAddress": {
      "description": "Ip Address",
      "type": "string",
      "example": "string"
    },
    "ActivityId": {
      "description": "Activity Id",
      "type": "string",
      "example": "500123"
    },
    "ActivityType": {
      "description": "Activity Type",
      "type": "string",
      "example": "string"
    }
  }
}