Create a webhook

Create a webhook

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

Creates a new webhook. Returns the webhook endpoint object with the secret field populated. You can create up to a maximum of 20 webhooks.

Headers

Name	Type	Description
Content-Type	string	The content-type must always be set to application/json.
Authorization	string	The live or sandbox API key.

Request Body

Name	Type	Description
description	string	A description of what the webhook is used for.
url	string	The URL of the webhook endpoint.
enabled	boolean	Determines whether the webhook should be active.
events	array	The list of event types to which the endpoint is subscribed for.

200 Webhook successfully created.

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

400 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 '{
          	"description": "This is my webhook, I like it a lot",
            "url": "https://example.com/my/webhook/endpoint",
            "enabled": true,
            "events": [
                 "check.pending",
                 "check.completed"
            ]
        }'

Node.js

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

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

const webhook = await complycube.webhook.create({
    description: "This is my webhook, I like it a lot",
    url: "https://example.com/my/webhook/endpoint",
    enabled: true,
    events: [
        "check.pending",
        "check.completed"
    ]
});

Python

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

my_hook = {
    'description': 'This is my webhook, I like it a lot',
    'url': 'https://example.com/my/webhook/endpoint',
    'enabled': True,
    'events': ['check.pending','check.completed']
}

hook = cc_api.webhooks.create(**my_hook)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$webhook = $ccapi->webhooks()->create([
    description => 'This is my webhook, I like it a lot',
    url => 'https://example.com/my/webhook/endpoint',
    enabled => true,
    events => [ 'check.pending','check.completed']
    ]);