Summary

This endpoint is used to edit the configuration of a pre-existing webhook subscription. Note that only the callbackURL, active, and headers fields are capable of being changed.

Modification of the scope or any storeId or orderId value is not supported.

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.

Request Parameters

scope

• The scope of the webhook subscription.
• Options:
  • order
  • restaurant
  • brand

id - required if scope is set to order or restaurant

• The ID value associated with the subscription’s restaurant or order
• Example: 3f4e0b3e-853d-4788-964a-2a31a169a9ad

Request Body

callbackURL (string) - optional

• The destination URL that will receive the webhook notifications.
• Example: "<https://example.com/webhook-destination>"

active (boolean) - optional

• True or false if this webhook subscription should be active. If set to false, webhook notifications will not be sent to the Callback URL.