Get a webhook

Get a webhook

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

Retrieves an existing webhook

Path Parameters

Name	Type	Description
id	string	The ID of the webhook.

Headers

Name	Type	Description
Authorization	string	The live or sandbox API key.

200 Webhook successfully retrieved.

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

404 Could not find a webhook matching the provided id.

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

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($id);