Get Webhook (webhook - GetWebhook)
Get a list of Webhooks by a specific user.
/** * Webhook::GetWebhooks * * Return a list of webhooks for a user. * * events [array of open|click|bounce|unsubsribe|complaint, optional]: event types * verified [bool, optional]: fetch only webhooks with verified urls * failed [bool, optional]: fetch only webhooks with failed urls * enabled [bool, optional]: fetch only enabled webhooks */ { "username": "matbt@pinpointe.com", "usertoken": "XXX", "requesttype": "Webhook", "requestmethod": "GetWebhooks", "details": { "events": "{*event_type*}", "{*event_type*}", ...] "verified": "{*bool*}", "failed": "{*bool*}", "enabled": "{*bool*}" } }
JSON Request Example:
json_request element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Webhook |
requestmethod | GetWebhook |
details element
Field Name | Description |
events (required) | Webhook id that needs deleted (Required) |
verified | Fetch webhooks with verified URLs (TRUE, FALSE) |
failed | Fetch webhooks with failed URLs (TRUE, FALSE) |
enabled | Fetch enabled webhooks (TRUE, FALSE) |
Successful Response
response element
Field Name | Description |
status | Returns SUCCESS when successful |
Unsuccessful Response
response element
Field Name | Description |
status | Returns FAILED when unsuccessful |
errormessage | Text explaining why webhook retrieval failed |