Otter · JSON Structure

Public Api Event Notification Base Structure

Notification message sent on relevant events.

Type: object Properties: 3 Required: 4
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

EventNotificationBase is a JSON Structure definition published by Otter, describing 3 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

eventId eventTime eventType

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-event-notification-base-structure.json",
  "name": "EventNotificationBase",
  "description": "Notification message sent on relevant events.",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "uuid",
      "description": "Unique identifier of the event.",
      "example": "c75d9460-5d48-423d-8d01-f825fd5b1672"
    },
    "eventTime": {
      "type": "datetime",
      "description": "Date of event occurrence.",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "eventType": {
      "type": "string",
      "description": "The type of event.",
      "example": "string"
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "eventType",
    "metadata"
  ]
}