The identity and technical contract details declared by the specification.
MobileAppsSubmissionUpdatedEvent
object
Mobile Apps event
11 properties
StoreOrderCapacityConfigEditModel
object
Represents one store's order capacity configuration edit
1 property
MenuSectionItem
object
Menu item
23 properties
RetentionCampaignUpdatedEvent
object
Retention campaign updated event
13 properties
StoreTipUpdatedEvent
object
Store Tip Updated
13 properties
HydraStoreUnassignedEvent
object
Hydra store\s unassigned event
11 properties
StoreOpeningHoursUpdatedEvent
object
Store Opening Hours Updated Event
17 properties
SmsInfo
object
Sms Info
3 properties
VoucherDeletedEvent
object
Voucher Deleted Event
13 properties
PushNotificationScheduledEvent
object
12 properties
OrderFulfillmentStatusUpdatedEvent
object
Fulfillment status updated event
14 properties
FeeSummary
object
Fee Summary
3 properties
App
object
App
28 properties
UserLoginEvent
object
User login event
11 properties
CatalogItem
object
CatalogItem
11 properties
4 required
Teammate
object
11 properties
MenuBulkEditEvent
object
Menu bulk event
16 properties
CatalogItemCreatedEvent
object
12 properties
LocationDeletedEvent
object
Event for logging the deleting of Locations
14 properties
OrderItem
object
Order item
14 properties
BluetoothTerminalStatus
object
Status of the bluetooth terminal
7 properties
MenuUpdatedEvent
object
Menu updated event
13 properties
GroupReference
object
Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group}
3 properties
2 required
FieldChangeInformation
object
Change information for a field
5 properties
OrderFulfillmentStatusBase
object
Fulfillment Status Information
3 properties
MobileAppsSubmissionStatusUpdatedEvent
object
Mobile Apps event
12 properties
WebhookSubscriptionCreatedEvent
object
10 properties
StoreAddress
object
Store address
10 properties
UpdateTipConfiguration
object
Describes the configuration of tipping
6 properties
AppStoreConfigUpdatedEvent
object
AppStore Config Updated event
12 properties
LoyaltyCampaign
object
Loyalty campaign
17 properties
UserAnsweredSignupQuestionsEvent
object
User answered signup questions event
11 properties
StoreDeletedEvent
object
Store Deleted Event
14 properties
StoreCreatedEvent
object
Store Created Event
13 properties
PrinterTurnedOnEvent
object
Printer turned on event
14 properties
DeliveryZoneUpdatedEvent
object
Delivery Zone Updated Event
14 properties
HydraUnAssignedEvent
object
Hydra unassigned event
11 properties
StoreKioskSetting
object
Store Kiosk Settings
9 properties
CustomerDeliveryTrackingOrder
object
Defines the order data required for customer driver tracking
19 properties
AppStoreSubscriptionChangeJobUpdatedEvent
object
Subscription change job status updated event
11 properties
Channel
object
Channel.
6 properties
StoreNote
object
Store note
3 properties
Store
object
Store
52 properties
CreditNoteDetails
object
Credit note details
1 property
CustomerDeliveryTrackingOrderLine
object
Defines an order line for driver tracking
2 properties
OrderDeliveryTrackingStatusUpdatedEvent
object
13 properties
OrderBatchSummary
object
Order batch info
4 properties
CatalogGroupReference
object
Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group}
4 properties
2 required
LoyaltyCampaignDeletedEvent
object
Loyalty campaign deleted event
13 properties
PromotionAward
object
Promotion
2 properties
MaskedPhoneNumber
object
Represents a masked phone number
3 properties
Language
object
Sorted Language
4 properties
HydraStatus
object
Hydra status
6 properties
2 required
BusinessHoursOverride
object
5 properties
2 required
Menu
object
Menu
14 properties
BusinessHoursPeriod
object
Business hours period
8 properties
Group
object
CatalogGroup
12 properties
3 required
StoreServiceChargeUpdatedEvent
object
Service Charge Updated Event
13 properties
DeliveryZoneDeletedEvent
object
Delivery Zone Deleted Event
14 properties
StoreAddressUpdatedEvent
object
Store Address Updated Event
14 properties
ServiceCharge
object
Store Service Charge
6 properties
KioskBluetoothTerminalCancelUpdateEvent
object
Kiosk bluetooth Cancel Update Install Event
12 properties
TeammateUpdatedEvent
object
11 properties
KioskBluetoothTerminalInitiateUpdateCheckEvent
object
Kiosk bluetooth trigger update check event
11 properties
WebhookSubscriptionDeletedEvent
object
10 properties
MenuItemOptionSetItem
object
Menu item option set item
15 properties
KioskBluetoothTerminalFirmwareVersionStatusEvent
object
Kiosk Stripe Terminal Update info received event
16 properties
KioskBluetoothTerminalInstallationStatusEvent
object
Kiosk bluetooth terminal Installation Status
14 properties
KioskBluetoothUnpairingModeEvent
object
Kiosk Bluetooth Unpairing mode initiated
12 properties
PrinterAssignedToStoreEvent
object
Printer assigned to store event
14 properties
StoreGroupCreatedEvent
object
Store Group Created Event
13 properties
BankAccountDeletedEvent
object
11 properties
DeliveryZone
object
Delivery Zone
6 properties
StoreBusinessHoursOverrideCreatedEvent
object
Store Business Hours Override Created
14 properties
Range
object
A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek.
3 properties
PushNotificationDeletedEvent
object
11 properties
Order
object
Order
53 properties
VoucherAppliedEvent
object
Voucher Applied Event
11 properties
HydraRequestResetEvent
object
Hydra request reset event
10 properties
DeliveryZoneCreatedEvent
object
Delivery Zone Created Event
14 properties
OrderRejectedEvent
object
Order Rejected Event
14 properties
MobileAppsSubmissionStatus
object
Mobile Apps Status
9 properties
CreateMetadata
object
Create metadata
3 properties
MenuCheckpointCreatedEvent
object
13 properties
OrderVoucherSummary
object
Voucher summary
7 properties
TeammateDeletedEvent
object
11 properties
AnalyticsClientEvent
object
Client Analytics event
15 properties
CatalogItemArchivedEvent
object
12 properties
MenuSectionDeletedEvent
object
13 properties
MenuItemOptionSetDeletedEvent
object
13 properties
DeviceSettings
object
Device settings for Hydra
3 properties
3 required
StoreBusinessHoursOverrideDeletedEvent
object
Store Business Hours Override Deleted
14 properties
StoreFeeConfigUpdatedEvent
object
Fee Config Updated Event
15 properties
ExternalStoreEvent
object
External event
22 properties
CatalogGroupUpdatedEvent
object
12 properties
TeammateInviteAcceptedEvent
object
11 properties
LoyaltyCampaignCreatedEvent
object
Loyalty campaign created event
13 properties
StoreLogoCreatedEvent
object
Store logo created
13 properties
MenuCreatedEvent
object
Menu created event
12 properties
HydraSettingChangedEvent
object
Hydra settings changed
11 properties
PrinterUnassignedFromStoreEvent
object
Printer assigned from store event
14 properties
UserCreatedEvent
object
User created event
11 properties
TelephonyConfig
object
Phone call
10 properties
UserDeletedEvent
object
User deleted event
11 properties
DnsVerifiedEvent
object
The DNS for the Hostname verified
10 properties
PrinterTurnedOffEvent
object
Printer turned off event
14 properties
HydraStoreAssignedEvent
object
Hydra store\s assigned event
11 properties
ChannelStoresUpdatedEvent
object
Channel Stores Updated Event
12 properties
MenuSectionItemUpdatedEvent
object
13 properties
StoreLogoUpdatedEvent
object
Store logo updated
13 properties
PercentDiscountDetails
object
Percent discount details
2 properties
PromotionDetails
object
Promotion
3 properties
AppStoreConfigDeletedEvent
object
AppStore Config Deleted event
12 properties
HydraAssignedEvent
object
Hydra assigned event
11 properties
BankAccountCreatedEvent
object
11 properties
Metafield
object
Metafield
2 properties
2 required
RetentionCampaignDeletedEvent
object
Retention campaign deleted event
13 properties
LocationCreatedEvent
object
Event for logging the creating of Locations
14 properties
StoreGroupDeletedEvent
object
Store Group Deleted Event
13 properties
PhoneCallEndedEvent
object
Phone call ended event
12 properties
CustomerSummary
object
Customer summary
6 properties
CustomerUpdatedEvent
object
Customer updated event
11 properties
PushNotificationRequest
object
Push Notification Details
3 properties
1 required
PreOrderConfig
object
Pre Order Config
10 properties
MenuAsyncCreationCompletedEvent
object
Menu async creation completed event
13 properties
CustomerCreatedEvent
object
Customer created event
11 properties
BankAccountUpdatedEvent
object
11 properties
MenuItemOptionSetCreatedEvent
object
13 properties
StoreCampaignStartTime
object
Store campaign start time
2 properties
ValidityPeriod
object
ValidityPeriod.
3 properties
UserPasswordCreatedEvent
object
User created password event
11 properties
MenuSectionAvailability
object
Menu section availability
2 properties
PhoneCallStartedEvent
object
Phone call started event
12 properties
WebhookSubscriptionUpdatedEvent
object
10 properties
OrderCustomerTrackingCreatedEvent
object
11 properties
KioskBluetoothTerminalUnpairedEvent
object
Kiosk Bluetooth Unpairing mode initiated
12 properties
PushNotificationSentEvent
object
11 properties
OrderDropOffLocation
object
OrderDropOffLocation.
6 properties
OrderRefundedEvent
object
Order Refunded Event
13 properties
MenuItemOptionSetUpdatedEvent
object
13 properties
Printer
object
Printer
2 properties
UserUpdatedEvent
object
User updated event
11 properties
UserEventInfo
object
User Event Info
4 properties
LumpDiscountDetails
object
Lump discount details
1 property
StoreArchivedEvent
object
Store Archived Event
14 properties
Product
object
Product
11 properties
4 required
OrderItemOption
object
Order item option
10 properties
TaxItem
object
A collection of tax items on the order.
3 properties
TeammateInviteSentEvent
object
11 properties
AccountFieldKeyValuePair
object
Represents one populated account field (its key and value)
2 properties
OrderBatchPublishedEvent
object
Order Batch Published Event
12 properties
AppStoreConfigCreatedEvent
object
AppStore Config Created event
12 properties
BankAccount
object
BANK ACCOUNT
14 properties
StoreUpdatedEvent
object
Store Updated Event
14 properties
MenuItemOptionSetItemUpdatedEvent
object
13 properties
CatalogGroupCreatedEvent
object
12 properties
StoreGroupUpdatedEvent
object
Store Group Updated Event
13 properties
AppUpdatedEvent
object
Application updated event
15 properties
TelephonyConfigUpdatedEvent
object
Telephony Config Updated Event
13 properties
RestApiEventSearchPaginationResult
object
4 properties
4 required
MenuSectionItemDeletedEvent
object
13 properties
HydraConnectionStatusChangedEvent
object
Hydra Connection Status Changed Event
12 properties
RetentionCampaignCreatedEvent
object
Retention campaign created event
13 properties
KioskTerminalActionStateChangedEvent
object
Kiosk Terminal action state changed
13 properties
OrderAcceptedEvent
object
Order Accepted Event
13 properties
StoreOrderCapacityPeriod
object
Represents a single order capacity period
6 properties
CertificateRenewedEvent
object
The DNS for the Hostname verified
10 properties
CatalogItemUpdatedEvent
object
12 properties
FlipdishError
object
Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.…
1 property
CatalogGroupArchivedEvent
object
12 properties
MenuSectionUpdatedEvent
object
13 properties
AppCreatedEvent
object
Application created event
14 properties
StoreGroup
object
Store Group
8 properties
MenuSectionItemCreatedEvent
object
13 properties
MenuItemOptionSetItemDeletedEvent
object
13 properties
BankAccountAssignedEvent
object
12 properties
KioskBluetoothPairingModeEvent
object
Kiosk Bluetooth Pairing mode initiated
12 properties
Setting
object
2 properties
MenuSection
object
Menu section
11 properties
MenuUploadedEvent
object
Menu uploaded event
14 properties
MenuTaxRate
object
Tax Rates Associated with a Menu
3 properties
MenuItemOptionSetItemCreatedEvent
object
13 properties
StoreMenuAssignedEvent
object
Menu Assigned To Store Event
13 properties
CustomerConsentUpdatedEvent
object
Customer consent updated
12 properties
StoreKioskSettingUpdatedEvent
object
Store kiosk setting updated
13 properties
Coordinates
object
Coordinates
2 properties
OrderCreatedEvent
object
Order Created Event
12 properties
StoreFeeConfig
object
53 properties
WebsiteVanityUrlUpdatedEvent
object
Website vanity url
12 properties
OrderRatingUpdatedEvent
object
Order Rating Update Event
12 properties
StoreSummary
object
Store summary
14 properties
CertificateCreatedEvent
object
The DNS for the Hostname verified
10 properties
KioskBluetoothTerminalUpdatedEvent
object
Kiosk bluetooth terminal unpaired
14 properties
DeliveryLocation
object
Delivery location
7 properties
StorePreOrderConfigUpdatedEvent
object
Store Pre order config updated
14 properties
MenuItemOptionSet
object
Menu item option set
12 properties
LocationAreaUpdatedEvent
object
Event for logging updates of LocationAreas
12 properties
OrderDispatchedEvent
object
Order Dispatched Event
12 properties
LocationAreaCreatedEvent
object
Event for logging creating of LocationAreas
12 properties
OrderTipUpdatedEvent
object
Order Tip Update Event
12 properties
ProductReference
object
Catalog Item associated
5 properties
2 required
MenuSectionCreatedEvent
object
13 properties
VoucherCreatedEvent
object
Voucher Created Event
13 properties
HydraConfig
object
Hydra configuration
7 properties
3 required
KioskBluetoothInstallUpdateInitiateEvent
object
Kiosk bluetooth Initiate Install Update Event
12 properties
VoucherUpdatedEvent
object
Voucher Updated Event
13 properties
StoreUnarchivedEvent
object
Store Unarchived Event
14 properties
PhoneCall
object
Phone call
11 properties
WebsiteUpdatedEvent
object
WebsiteUpdatedEvent
12 properties
UpdateAppStoreAppConfigurationWebhookDTO
object
4 properties
2 required
CampaignStatistics
object
Campaign statistics
5 properties
SmsReceivedEvent
object
Sms received event
11 properties
RetentionCampaign
object
Retention campaign
16 properties
StoreUnpublishedEvent
object
Store Unpublished Event
14 properties
EmvNotificationEvent
object
Order Terminal Notification
19 properties
EventSearchResult
object
141 properties
OrderCapacityConfigUpdatedEvent
object
Store's Order Capacity Configuration Updated
13 properties
LoyaltyCampaignUpdatedEvent
object
Loyalty campaign updated event
13 properties
StorePublishedEvent
object
Store Published Event
14 properties
Voucher
object
Voucher
33 properties
StoreLogoDeletedEvent
object
Store logo deleted
12 properties
WebhookSubscriptionEventInfo
object
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Flipdish publishes across the network.