Subscriber List

6 min

listing subscribers and subscriptions the subscriber query returns information about the subscriber and subscriptions for the integration this query can be useful in determining if you have successfully created a subscriber or subscriptions at this time we only allow one subscriber per api user query query query subscribers { subscribers { id name subscriptions { evententity eventkey parententity parentid subscriberid } webhookurl } } return type returns a subscription schema reference docid 6fu5dgr5rpbwat27pcxz successful responses when the subscribers query succeeds you can expect the response payload to look in one of three different ways if you have not yet created a subscriber the subscribers field value will empty if you have created a subscriber but have not yet created any subscriptions the subscriptions field value will empty if you have created subscriptions all of them for the subscriber will be returned response without subscribers { "data" { "subscribers" \[] } } response without subscriptions { "data" { "subscribers" \[ { "id" "your subscriber id", "name" "example provider updated example brand", "subscriptions" \[], "webhookurl" "https //example net/subscriptions" } ] } } response with subscriptions { "data" { "subscribers" \[ { "id" "your subscriber id", "name" "example provider updated example brand", "subscriptions" \[ { "evententity" "menu", "eventkey" "updated", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" }, { "evententity" "menucreationrequest", "eventkey" "failed", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" }, { "evententity" "menucreationrequest", "eventkey" "succeeded", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" }, { "evententity" "menucreationrequest", "eventkey" "succeeded with warnings", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" }, { "evententity" "order", "eventkey" "accepted", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" }, { "evententity" "order", "eventkey" "cancelled", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" }, { "evententity" "order", "eventkey" "rejected", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" }, { "evententity" "order", "eventkey" "submitted", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" }, { "evententity" "order", "eventkey" "uncancelled", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" } ], "webhookurl" "https //example net/subscriptions" } ] } } failure responses when the subscribers query fails you can expect the response payload to look like response without subscribers { "data" { "subscribers" \[] } }