Skip to content

Developer Documentation

Introduction
Getting Started
Getting Started
Guides
Guides
- Rate Limiting
- Webhook Authentication
Domains
Domains
- Account Pairing
  Account Pairing
  - Operations
  - Integration Flows
    Integration Flows
    
    Store Onboarding
    
    Partial Store Onboarding
- Delivery
  Delivery
  - Operations
  - Integration Flows
    Integration Flows
    
    Delivery Creation Flow
    
    Delivery Cancellation Flow
    
    Error Event Flow
- Finance
  Finance
  - Operations
  - Integration Flows
    Integration Flows
    
    Financial Transaction Flow
- Menus
  Menus
  - Operations
  - Integration Flows
    Integration Flows
    
    Menu Publish Flow
    
    Update Menu Entities Availability Flow
    
    Upsert Hours Flow
    
    Failed Event Flow
- Menus Manager
  Menus Manager
  - Operations
  - Integration Flows
    Integration Flows
    
    Read and Upsert Menus Flow
    
    Publish Menus To Target Flow
    
    Suspend/Unsuspend Menu Entities Flow
    
    Manager Menu Sync Flow
- Orders
  Orders
  - Order Consumer Integration
    Order Consumer Integration
    
    Operations
    
    Integration Flows
    Integration Flows
    
    Order Create Event Flows
    
    Order Status notifications
  - Order Provider Integration
    Order Provider Integration
    
    Operations
    
    Integration Flows
    Integration Flows
    
    Orders Lifecycle
    
    Orders Creation Flow
    
    Orders Cancellation Event Flow
    
    Migration to Order Total v2
- Organization
  Organization
  - Integration Flows
    Integration Flows
    
    Onboarding Flow
- Reports
  Reports
  - Operations
  - Reports
    Reports
    
    Orders Report
    
    Order Items Report
    
    Payout Transactions Report
    
    Ratings & Reviews Report
  - Integration Flows
    Integration Flows
    
    Report with a Notification Flow
    
    Report without Notification Flow
- Reviews
  Reviews
  - Operations
  - Integration Flows
    Integration Flows
    
    Reply to a Review Flow
- Storefront
  Storefront
  - Operations
  - Integration Flows
    Integration Flows
    
    Get Store Availability Event Flow
    
    Pause/Unpause Event Flow
- Loyalty Manager
  Loyalty Manager
  - Operations
- Direct Order
  Direct Order
  - Operations
- Store
  Store
  - Operations
OpenAPI Reference

Onboard your webhook configurations

The Public API allows you to configure your integration to receive Webhook into your system. Please reach out to your Account Representative to register to receive Webhooks from the API.