Update a webhook
URL
POST https://api.complycube.com/v1/webhooks/:id
Updates the specified webhook by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Headers
Name
Type
Description
Content-Type*
string
The content-type must always be set to application/json.
Authorization*
string
The API live or test key.
Path parameters
Name
Type
Description
id*
string
The ID of the webhook.
Body
Name
Type
Description
url
string
URL of the webhook.
description
string
An optional description of what the webhook is used for.
enabled
boolean
Determines whether the webhook should be active.
events
array
[string]
The list of event types for which the event is subscribed
Example request
curl -X POST https://api.complycube.com/v1/webhooks/:id \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"description": "updated description"
}'const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const webhook = await complycube.webhook.update("WEBHOOK_ID", {
description: "updated description"
});from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
webhook = cc_api.webhooks.update('WEBHOOK_ID', description="updated description")use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$webhook = $ccapi->webhooks()->update('WEBHOOK_ID', [
'description' => 'updated description'
]);