API Reference
v1.7.3
Search…
⌃K

Update a webhook

post
https://api.complycube.com
/v1/webhooks/:id
Update a webhook
Updates the specified webhook by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
Path
id*
string
The ID of the webhook.
Header
Content-Type*
string
The content-type must always be set to application/json.
Authorization*
string
Authentication token to track down who is emptying our stocks.
Body
url
string
URL of the webhook.
enabled
string
Determines whether the webhook should be active.
events
string
The list of event types for which the event is subscribed
description
string
An optional description of what the webhook is used for.
Responses
200
Webhook successfully retrieved.
404
An example of a Bad Request response, when an invalid event type is provided

Example request

cURL
Node.js
Python
PHP
.NET
curl -X POST https://api.complycube.com/v1/webhooks \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"id": "WEBHOOK_ID",
"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']);
using ComplyCube.Net;
using ComplyCube.Net.Resources.Webhooks;
var webhookApi = new WebhookApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var update = new WebhookRequest { description = "Updated description" };
var webhook = await webhookApi.UpdateAsync("WEBHOOK_ID", update);