Update a webhook

Update a webhook

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.

Path Parameters

Name	Type	Description
id	string	The ID of the webhook.

Headers

Name	Type	Description
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.

Request Body

Name	Type	Description
description	string	An optional description of what the webhook is used for.
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

200 Cake successfully retrieved.

{
  "id": "5ed1712e99c81a0007b9a3d6",
  "description": "Updated description",
  "url": "https://example.com/my/webhook/endpoint",
  "enabled": true,
  "events": [
    "check.created",
    "check.completed"
  ],
  "secret": "akuPkDmpn1lFiMchfmSjsQMj0sUQ4IRH"
  "createdAt": "2020-01-29T20:31:42.375Z",
  "updatedAt": "2020-01-29T20:32:22.000Z"
}

404 An example of a Bad Request response, when an invalid event type is provided

{
    "type": "invalid_request",
    "message": "'events' should be equal to one of the allowed values:check.created, check.completed",
    "param": "type"
}

Example request

cURL

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"
        }'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const webhook = await complycube.webhook.update("WEBHOOK_ID", {
   description: "updated description"
});

Python

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

hook = cc_api.webhooks.update('WEBHOOK_ID',enabled=False)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$webhook = $ccapi->webhooks()->update('WEBHOOK_ID', ['enabled' => false]);