Summary

This endpoint is used to create new webhook subscriptions using the information provided within the request body. Subscriptions will not be active unless the active field is set to true.

Headers

X-Flyt-API-Key: the API key you received from JETConnect. This API key is the same API key used in menus. You should not share this API key with anyone outside your organization.

Content-Type: application/json

Request Body

scope (string)

• The scope of the webhook subscription.
• Options:
  • "order"
  • "restaurant"
  • "brand"
• NOTE: order-scoped subscriptions only remain valid for 24 hours.

orderId (string) - required if scope is set to order

• The long-form Skip Order ID associated with a specific order.
• Example: "3f4e0b3e-853d-4788-964a-2a31a169a9ad"

storeId (string) - required if scope is set to restaurant

• Brand-provided Store ID associated with a specific restaurant. The restaurant must have already been integrated and the provided Store ID must match with the ID configured in the JETConnect platform.
• Example: "103539"

callbackURL (string)