Update Webhook (webhook - UpdateWebhook)
Update 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 Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Webhook |
| requestmethod | UpdateWebhook |
details element
| Field Name | Description |
| id | Webhook id that needs tested (Required) |
| event | Type of event (open, click, bounce, unsubscribe, complaint) |
| url | URL to catch event posts |
| name | Unique name for webhook |
| enabled | Enable the webhook (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 deletion failed |