Public API
Menus API

Subscribing to Menu Creation Request Notifications

13min

Subscribing to Menu Creation Request Notifications

Subscribing to Menu Creation Request notifications works in the same way as for other event subscriptions already documented.

Operation

GraphQL


Request variables

GraphQL


Input Fields

CreateSubscriptionFields Type

The name of the entity to receive notifications about (e.g. for notifications each time an order is accepted, this would be Order). For the Menu Create API use the EventEntity enum of MenuCreationRequest.

GraphQL


The particular action to notify on (e.g. for notifications when an order is accepted, this would be accepted). For the Menu Create API subscribe to the EventKey enums of succeeded, succeeded_with_warnings, and failed.

GraphQL


The owner of the entity to receive notifications about (e.g. the specific catering location to receive order accepted notifications for, etc.). For the Menu Create API the ParentEntity enum should be Caterer.

GraphQL


An ID for the owner of the entity to receive notifications about. For the Menu Public API the ParentId value should be a Caterer UUID.

GraphQL


An ID for the subscriber wanting to receive these events.

GraphQL


Enums

EntityEvent Type

The name of the entity to receive subscription notifications about. For the Menu Create API use the EventEntity enum of MenuCreationRequest.

GraphQL


EventKey Type

The particular event to notify on. For the Menu Create API subscribe to the EventKey enums of succeeded, succeeded_with_warnings, and failed.

GraphQL


Receiving Menu Creation Webhooks

Success

GraphQL


Success With Warning

GraphQL


Failure

GraphQL