« Back to Documentation Overview

listWebhooks – v1.3

 listWebhooks(string apikey, string id)

Return the Webhooks configured for the given list

Section
List Related
Parameters
apikey a valid API Key for your user account. Get by visiting your API dashboard
id the list id to connect to. Get by calling lists()
Returns
array list of webhooks
stringurlthe URL for this Webhook
arrayactionsthe possible actions and whether they are enabled
boolsubscribetriggered when subscribes happen
boolunsubscribetriggered when unsubscribes happen
boolprofiletriggered when profile updates happen
boolcleanedtriggered when a subscriber is cleaned (bounced) from a list
boolupemailtriggered when a subscriber's email address is changed
boolcampaigntriggered when a campaign is sent or canceled
arraysourcesthe possible sources and whether they are enabled
booluserwhether user/subscriber triggered actions are returned
booladminwhether admin (manual, in-app) triggered actions are returned
boolapi whether api triggered actions are returned