Subscription Schema Reference

22 min

subscription schema reference objects createsubscriberpayload return type of createsubscriber true 323,100 unhandled content type unhandled content type unhandled content type unhandled content type example { "subscriber" newsubscriber! } createsubscriptionpayload return type of createsubscription true 323,100 unhandled content type unhandled content type unhandled content type unhandled content type example { "subscription" eventsubscription! } updatesubscriberpayload return type of updatesubscriber true 323,100 unhandled content type unhandled content type unhandled content type unhandled content type example { "subscriber" subscriber! } inputobjects createsubscriberfields input object for making new subscribers true 303,100 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "name" "example provider example brand", "webhookurl" "https //example net/subscriptions" } createsubscriptionfields input object for making new subscriptions true 287,100 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type 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 true 330,100 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type 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 true 319,100 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type 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 true 331,100 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "id" "your subscriber id", "name" "example provider example brand", "subscriptions" \[eventsubscription!]!, "webhookurl" "https //example net/subscriptions" } updatesubscriberfields input object for updating subscribers true 303,100 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type 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 true 287,100 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type 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 true 287,100 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type 1 1 unhandled content type 1 1 unhandled content type 1 1 unhandled content type 1 1 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type parententity the owner of the entity to receive notifications about applied to the parententity type as the field's return type true 287,100 unhandled content type unhandled content type unhandled content type unhandled content type 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