Subscription Schema Reference

subscription schema reference objects createsubscriberpayload return type of createsubscriber field name description subscriber docid 6fu5dgr5rpbwat27pcxz the information about a newly created subscriber example { "subscriber" newsubscriber! } createsubscriptionpayload return type of createsubscription field name description subscription docid 6fu5dgr5rpbwat27pcxz the information about a newly created event subscription example { "subscription" eventsubscription! } updatesubscriberpayload return type of updatesubscriber field name description subscriber docid 6fu5dgr5rpbwat27pcxz the information about an updated subscriber example { "subscriber" subscriber! } inputobjects createsubscriberfields input object for making new subscribers field name description name /#string the entity subscribing to event notifications naming convention is \<provider using integration> \<affiliated brand> webhookurl /#string an url where subscription notification events will be sent to example { "name" "example provider example brand", "webhookurl" "https //example net/subscriptions" } createsubscriptionfields input object for making new subscriptions field name description evententity /#evententity a evententity enum of the entity to receive notifications about (e g for notifications each time an order event occurs, this would be order ) eventkey /#eventkey a eventkey enum of the particular event to notify on (e g for notifications when an order is accepted, this would be an accepted event) parententity docid 6fu5dgr5rpbwat27pcxz a parententity enum indicating the owner of the entity to receive notifications about (e g the specific catering location to receive order accepted notifications for, etc ) parentid /#uuid 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 subscriberid /#id an id for the subscriber wanting to receive these events example { "evententity" "order", "eventkey" "accepted", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" } eventsubscription a subscription allows a subscriber to enable notifications for a particular event (e g when an order is accepted at a particular catering location) when a subscription is created, all event notifications will be received at the subscriber’s webhook url field name description evententity /#evententity a evententity enum of the entity to receive notifications about (e g for notifications each time an order event occurs, this would be order ) eventkey /#eventkey a eventkey enum of the particular event to notify on (e g for notifications when an order is accepted, this would be an accepted event) parententity docid 6fu5dgr5rpbwat27pcxz a parententity enum indicating the owner of the entity to receive notifications about (e g the specific catering location to receive order accepted notifications for, etc ) parentid /#uuid 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 subscriberid /#id an id for the subscriber wanting to receive these events example { "evententity" "order", "eventkey" "accepted", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" } newsubscriber this object represents a url to receive all subscription notifications one subscriber can be created per access token a subscriber can have many subscriptions field name description id /#id the id for the subscriber name /#string the entity subscribing to event notifications naming convention is \<provider using integration> \<affiliated brand> subscriptions docid 6fu5dgr5rpbwat27pcxz active event subscriptions for the subscriber webhooksecret /#string the token provided when posting events to the webhook to ensure the notification was sent by ezcater webhookurl /#string an url where subscription notification events will be sent to example { "id" "your subscriber id", "name" "example provider example brand", "subscriptions" \[eventsubscription!]!, "webhooksecret" "be6efd0f8e88fec0d51364559ca9a258e70031f7f38448ea2e9705928a929a8d", "webhookurl" "https //example net/subscriptions" } subscriber this object represents a url to receive all subscription notifications one subscriber can be created per access token a subscriber can have many subscriptions field name description id /#id the id for the subscriber name /#string the entity subscribing to event notifications naming convention is \<provider using integration> \<affiliated brand> subscriptions docid 6fu5dgr5rpbwat27pcxz active event subscriptions for the subscriber webhookurl /#string an url where subscription notification events will be sent to example { "id" "your subscriber id", "name" "example provider example brand", "subscriptions" \[eventsubscription!]!, "webhookurl" "https //example net/subscriptions" } updatesubscriberfields input object for updating subscribers field name description name /#string the entity subscribing to event notifications naming convention is \<provider using integration> \<affiliated brand> webhookurl /#string an url where subscription notification events will be sent to example { "name" "example provider example brand", "webhookurl" "https //example net/subscriptions" } enums evententity the name of the entity to receive subscription notifications about applied to the evententity type as the field's return type enum name description menu the menu event entity is used to receive subscription notifications for menu events menucreationrequest the menucreationrequest event entity is used to receive subscription notifications for menu creation request events order the order event entity is used to receive subscription notifications for order events eventkey the particular event to notify on applied to the eventkey type as the field's return type as the integration functionality expands, there may be additional event subscription options as well enum name description submitted an order entity event indicating an order has been placed by the ordering customer accepted an order entity event indicating an order has been accepted or an order has been updated & that update is accepted by there caterer or on behalf of a caterer through a partner integration rejected an order entity event indicating an order has been rejected by a caterer or on behalf of a caterer through a partner integration cancelled an order entity event indicating an order has been cancelled by the ordering customer, or ezcater on behalf of the caterer uncancelled an order entity event indicating an order has been uncancelled by the ordering customer, or ezcater on behalf of the caterer relish finalized an order entity event indicating that a relish order has been finzliaed post cutoff, and that the order now contains all the items to be delivered that day updated a menu entity event indicating that a menu has been changed succeeded a menucreationrequest entity event indicating that a menu creation request has completed successfully succeeded with warnings a menucreationrequest entity event indicating that a menu creation request has completed successfully but with warnings that may require review failed a menucreationrequest entity event indicating a menu creation request has failed with errors that require review parententity the owner of the entity to receive notifications about applied to the parententity type as the field's return type enum name description caterer the caterer is they only owner available today scalars id the id scalar type represents a unique identifier, often used to refetch an object or as key for a cache the id type appears in a json response as a string; however, it is not intended to be human readable when expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an id string the string scalar type represents textual data, represented as utf 8 character sequences the string type is most often used by graphql to represent free form human readable text uuid universally unique identifier as defined by rfc 4122