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