List webhooks

URL

GET https://api.complycube.com/v1/webhooks

This endpoint allows you to list all existing webhooks.

Headers

Name	Type	Description
Authorization*	string	The API live or test key.

Query parameters

Name	Type	Description
<pagination>	string	The number of items to return and the number of pages to offset.
<filtering>	string	Filter the results.

You can use pagination and webhook filters for this endpoint.

Example request

cURL

curl -X GET https://api.complycube.com/v1/webhooks \
     -H 'Authorization: <YOUR_API_KEY>' 

Node.js

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

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

const webhooks = await complycube.webhook.list();

Python

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

webhooks = cc_api.webhooks.list()

PHP

use ComplyCube\ComplyCubeClient;

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

$webhooks = $ccapi->webhooks()->list();

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.Webhooks;

var webhookApi = new WebhookApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var webhooks = await webhookApi.ListAsync();

Example response

Success (200)

{
    "page": 1,
    "pageSize": 100,
    "totalItems": 1,
    "pages": 1,
    "items": [
        {
          "id": "5ed1712e99c81a0007b9a3d6",
          "description": "Updated description",
          "url": "https://example.com/my/webhook/endpoint",
          "enabled": true,
          "events": [
            "check.pending",
            "check.completed"
          ],
          "createdAt": "2020-01-29T20:31:42.375Z",
          "updatedAt": "2020-01-29T20:32:22.000Z"
        }
    ]
}