Webhooks

Update webhook subscription

Update an existing webhook subscription configuration including callback URL, event types, and delivery settings. What you can update:

  • Callback URL: Change where webhooks are delivered (must remain HTTPS)
  • Event types: Add new events to monitor or remove events you no longer need
  • Property scope: Change from specific properties to all properties or vice versa
  • Status: Enable or disable the subscription without deleting it

Update behavior:

  • Atomic operation: All changes succeed or fail together
  • Immediate effect: Changes apply to new events immediately
  • Event history: Past webhook deliveries are not affected
  • Validation: New event types must exist in the event catalog and be enabled

Common update scenarios:

  • Expand monitoring: Add new event types as your integration grows
  • Change destination: Update callback URL when moving to new infrastructure
  • Maintenance mode: Temporarily disable without losing configuration

Important notes:

  • Removing event types stops future notifications for those events
  • URL changes take effect immediately for new events
  • Disabled subscriptions retain configuration but stop sending webhooks
post/orgs/{orgId}/subscriptions/{subId}

Request

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

Path parameters

subIdstring required
Example:sub_c7129f82-c87d-470c-a8c8-cae6b07762e2

Unique webhook subscription identifier that tracks a specific webhook configuration within an org. Each subscription defines which events to listen for, where to send webhooks (callback URL), and delivery preferences. Subscriptions can monitor multiple event types and are scoped to either all properties within an org or a specific property. Format: "sub_" followed by a UUID (e.g., sub_c7129f82-c87d-470c-a8c8-cae6b07762e2).

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

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

array of properties id

Example request

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

Response

No Content - subscription updated successfully

Changes

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