Get Webhook (webhook - GetWebhook)

Get a list of Webhooks by a specific user.


/**
 * Webhook::DeleteWebhook
 *
 *  Delete a webhook
 *
 *  id [int, required]: id of webhook to be deleted
 */
{
  "username": "{*user*}",
  "usertoken": "{*token*}",
  "requesttype": "Webhook",
  "requestmethod": "DeleteWebhook",
  "details": {
    "id": "{*int*}", /* required */
  }
}


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
eventsWebhook 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