Webhooks

Create webhook subscription

Create a new webhook subscription to start receiving real-time notifications about business events in your Flipdish org.

What is a webhook subscription? A webhook subscription tells Flipdish which business events you want to monitor and where to send notifications when those events occur. For example, you might want to receive notifications whenever:

  • A new order is placed (order.created)
  • A menu is updated (menu.published)
  • A customer registers (customer.created)

How it works:

  1. Choose events: Select which business events matter to your integration
  2. Set destination: Provide an HTTPS endpoint where we'll send notifications
  3. Configure scope: Subscribe to events from all properties or specific ones
  4. Receive webhooks: Get real-time HTTP POST requests with event data

Event delivery:

  • Events are delivered as HTTP POST requests to your callback URL
  • Includes event data, and signature for verification
  • Automatic retries for failed deliveries
  • Alert emails for persistent delivery failures

Security:

  • All webhook URLs must use HTTPS for security
  • Each subscription includes a secret for signature verification
  • Webhooks include timing and idempotency headers for deduplication
post/orgs/{orgId}/subscriptions

Request

  • Base URL: https://api.flipdish.co/webhooks
  • URL: https://api.flipdish.co/webhooks/orgs/{orgId}/subscriptions
  • Auth: API key in header Authorization

Path parameters

orgIdstring required
Example:org123

Unique organization identifier representing a restaurant chain, franchise group, or independent restaurant business in the Flipdish platform. Organizations are the top-level tenant entity that groups brands, properties, and sales channels together. All webhook subscriptions are scoped to a specific organization to ensure proper data isolation and access control. Format: "org" followed by numbers (e.g., org123, org456).

Request body

orgIdstring required
callbackUrlstring uri required
eventTypesstring[] required
secretstring required
enabledboolean
propertyIdsstring[] required

array of properties id

createdBystring

Example request

{
  "propertyIds": [
    "p123",
    "p124"
  ]
}

Response

Webhook subscription for event types created successfully

Example response

{
  "data": {
    "propertyIds": [
      "p123",
      "p124"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.