Webhook Remove
The Webhook Remove method allows you to delete a specific webhook.
Request
IMPORTANT: Do not send more than 10 concurrent API requests.
Body Example
{
"id": "YOUR_WEBHOOK_ID"
}
Parameters
Title | Type | Default | Description |
---|---|---|---|
id required
|
integer |
The identifier of the webhook you want to delete. |
Response
{
"result": true
}
Parameters
Title | Type | Description |
---|---|---|
result |
boolean |
Indicated that the query was successful or not:
|
Method Errors
{
"result": false,
"errors": [
"Error description"
]
}
Error |
---|
"Argument id must be a positive integer" |
"Web hook config {id} not found in your account" |
"Invalid authorization token!" |
"Internal server error" |
"Bad Request" |
"no matches found for access token {accessToken}" |
"user {id} not enabled" |
"no data found for key {userId}" |
"access token check failed for key/secret $key/$accessToken" |
"Argument {argument} required" |
Code Examples
$accessToken = 'YOUR_API_KEY';
$url = 'https://api.wooxy.com/v3/webhook/remove';
$body = json_encode([
'id' => 'YOUR_WEBHOOK_ID',
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Access-Token: $accessToken",
'Content-Type: application/json',
'Content-Length: ' . strlen($body),
]);
$result = curl_exec($ch);
if ($result === false) {
echo 'cURL error: ' . curl_error($ch) . PHP_EOL;
} else {
echo $result . PHP_EOL;
}
curl_close($ch);