Vision 6

deleteWebhook

Deletes the specified Webhook.

deleteWebhook

Deletes the specified Webhook.

Top ↑

Syntax

integer deleteWebhook( string api_key, int webhook_id );

API Key Access Level required: Full access

Parameters

api_key (string)

The key required to access the API. See Getting Started for more information.

webhook_id (int)

The ID of the Webhook to delete.

Return Value

Returns the deleted Webhook ID on success.

Examples

PHP

$api = new Api($url, 'YOURAPIKEY');
$webhook = $api->invokeMethod('deleteWebhook', 616);

JSON Request

{
    "id": 1,
    "method": "deleteWebhook",
    "params": [
        "YOURAPIKEY",
        616
    ]
}

JSON Response

{
    "id": 1,
    "result": 616,
    "error": null
}

Error Codes

This method may return the following error codes in addition to the standard error codes:

Code Error Description
310 Invalid Method Parameters One or more parameters are invalid.
350 Unable to load webhook Invalid Webhook ID

See Also