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	string	Determines whether the webhook should be active.
events	string	The list of event types for which the event is subscribed

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>')

webhook = cc_api.webhooks.update('WEBHOOK_ID', description="updated description")

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$webhook = $ccapi->webhooks()->update('WEBHOOK_ID', [
    'description' => 'updated description'
]);

.NET

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);

Example response

Success (200)

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

Resource Not Found (404)

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