Flipdish · Schema

ExternalStoreEvent

External event

RestaurantOnline OrderingMobile AppsPoint-of-SaleOrderMenusPaymentsWebhook

Properties

Name Type Description
EventName string The event name
StoreId integer Store Id
User object
Description string Description
DescriptionFormat string Description with format placeholders
DescriptionFields string Description with format placeholders
DescriptionId string Description
Ref1 string Ref (reference field)
Ref2 string Ref2 (reference field)
Ref3 string Ref3 (reference field)
Ref4 string Ref4 (reference field)
OrderId integer Order Id
Tags array Tags
FieldChanges array Field changes list
FlipdishEventId string The identitfier of the event
CreateTime string The time of creation of the event
Position integer Position
AppId string App id
OrgId string Org id
IpAddress string Ip Address
ActivityId string Activity Id
ActivityType string Activity Type
View JSON Schema on GitHub

JSON Schema

platform-external-store-event-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/platform-external-store-event-schema.json",
  "title": "ExternalStoreEvent",
  "description": "External event",
  "type": "object",
  "properties": {
    "EventName": {
      "description": "The event name",
      "type": "string",
      "example": "Example Name"
    },
    "StoreId": {
      "format": "int32",
      "description": "Store Id",
      "type": "integer",
      "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": {
      "format": "int32",
      "description": "Order Id",
      "type": "integer",
      "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": {
      "format": "uuid",
      "description": "The identitfier of the event",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "CreateTime": {
      "format": "date-time",
      "description": "The time of creation of the event",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "Position": {
      "format": "int32",
      "description": "Position",
      "type": "integer",
      "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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/platform-external-store-event"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.