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 NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeWebhook
requestmethodGetWebhook


details element


Field NameDescription
events
(required)
Webhook id that needs deleted (Required)
verifiedFetch webhooks with verified URLs (TRUE, FALSE)
failedFetch webhooks with failed URLs (TRUE, FALSE) 
enabledFetch enabled webhooks (TRUE, FALSE) 


Successful Response


response element


Field NameDescription
statusReturns SUCCESS when successful


Unsuccessful Response


response element


Field NameDescription
statusReturns FAILED when unsuccessful
errormessageText explaining why webhook retrieval failed