Test Webhook (webhook - TestWebhook)

Test Webhook.


/**
 * Webhook::TestWebhook
 *
 *  Test a webhook
 *
 *  id [int, required]: id of webhook to be tested
 */
{
  "username": "{*user*}",
  "usertoken": "{*token*}",
  "requesttype": "Webhook",
  "requestmethod": "TestWebhook",
  "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
requestmethodTestWebhook


details element


Field NameDescription
idWebhook id that needs tested (Required)


Successful Response


response element


Field NameDescription
statusReturns SUCCESS when successful


Unsuccessful Response


response element


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