Skip to main content

Subscribing to Menu Notifications

Subscribing to Menu Notifications

Subscribing to Menu and Menu Creation Request notifications works in the same way as for other event subscriptions documented in the Subscription API[relink] section. Please refer to this section for detailed information, including what input fields and enums are available.

Menu Creation Request Notifications

When subscribing to MenuCreationRequest notifications please use:

  • EventEntity enum of MenuCreationRequest.

  • EventKey enums of succeeded, succeeded_with_warnings, or failed.

  • ParentEntity enum should be Caterer.

Variables

Below is a example of the variables that would be used with Subscription Create to subscribe to MenuCreationRequest notifications.

Variables

{
  "subscriptionParams": {
    "eventEntity": "MenuCreationRequest",
    "eventKey": "succeeded",
    "parentEntity": "Caterer",
    "parentId": "ezcater-caterer-id",
    "subscriberId": "your-subscriber-id"
  }
}

Notifications

Notification - Success

{
  "id": "notification-id",
  "parent_type": "Caterer",
  "parent_id": "ezcater-caterer-id",
  "entity_type": "MenuCreationRequest",
  "entity_id": "your-menu-creation-request-id",
  "key": "succeeded",
  "created_at": "2025-04-15 23:48:23 UTC",
  "occurred_at": "2025-04-15 23:48:21 UTC",
  "updated_at": "2025-04-15 23:48:23 UTC",
  "payload":null
}

Notification - Success With Warning

{
  "id": "notification-id",
  "parent_type": "Caterer",
  "parent_id": "ezcater-caterer-id",
  "entity_type": "MenuCreationRequest",
  "entity_id": "your-menu-creation-request-id",
  "key": "succeeded_with_warnings",
  "created_at": "2025-04-15 23:48:23 UTC",
  "occurred_at": "2025-04-15 23:48:21 UTC",
  "updated_at": "2025-04-15 23:48:23 UTC",
  "payload":null
}

Notification - Failed

{
  "id": "notification-id",
  "parent_type": "Caterer",
  "parent_id": "ezcater-caterer-id",
  "entity_type": "MenuCreationRequest",
  "entity_id": "your-menu-creation-request-id",
  "key": "failed",
  "created_at": "2025-04-15 23:48:23 UTC",
  "occurred_at": "2025-04-15 23:48:21 UTC",
  "updated_at": "2025-04-15 23:48:23 UTC",
  "payload":null
}

Menu Notifications

When subscribing to Menu notifications please use:

  • EventEntity enum of Menu.

  • EventKey enums of updated.

  • ParentEntity enum should be Caterer.

Variables

Below is a example of the variables that would be used with Subscription Create to subscribe to Menu notifications.

Variables

{
  "subscriptionParams": {
    "eventEntity": "Menu",
    "eventKey": "Updated",
    "parentEntity": "Caterer",
    "parentId": "ezcater-caterer-id",
    "subscriberId": "your-subscriber-id"
  }
}

Notifications

Notification

{
  "id": "notification-id",
  "parent_type": "Caterer",
  "parent_id": "ezcater-caterer-id",
  "entity_type": "Menu",
  "entity_id": "your-menu-creation-request-id",
  "key": "updated",
  "created_at": "2025-04-15 23:48:23 UTC",
  "occurred_at": "2025-04-15 23:48:21 UTC",
  "updated_at": "2025-04-15 23:48:23 UTC",
  "payload":null
}
Related Articles
Did this answer your question?