Get a webhook

URL

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

Retrieves an existing webhook

Headers

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

Path parameters

Name	Type	Description
id*	string	The ID of the webhook.

Example request

cURL

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

Node.js

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

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

await complycube.webhook.get("WEBHOOK_ID")

Python

from complycube import ComplyCubeClient

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

hook = cc_api.webhooks.get('WEBHOOK_ID')

PHP

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

$webhook = $ccapi->webhooks()->get('WEBHOOK_ID');

.NET

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

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

var webhook = await webhookApi.GetAsync("WEBHOOK_ID");

Example response

Success (200)

{
  "id": "5ed1712e99c81a0007b9a3d6",
  "description": "This is my webhook, I like it a lot",
  "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:31:42.375Z"
}

Resource Not Found (404)

{
    "type": "resource_not_found",
    "message": "Invalid webhook id '5eb1276f96be4a0008713af7'"
}