Create a webhook

URL

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 API live or test key.

Body

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

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://yoursite.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://yoursite.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://yoursite.com/my/webhook/endpoint',
    'enabled': True,
    'events': ['check.pending','check.completed']
}

webhook = 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://yoursite.com/my/webhook/endpoint',
    'enabled' => true,
    'events' => ['check.pending', 'check.completed']
]);

.NET

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

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

var webhookRequest = new WebhookRequest {
  url = "https://yoursite.com/my/webhook/endpoint",
  description = "This is my webhook, I like it a lot",
  enabled = true,
  events = new string[] {
    "check.completed",
    "check.pending"
  }
};

var webhook = await webhookApi.CreateAsync(webhookRequest);

Example responses

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.created",
    "check.completed"
  ],
  "secret": "akuPkDmpn1lFiMchfmSjsQMj0sUQ4IRH"
  "createdAt": "2020-01-29T20:31:42.375Z",
  "updatedAt": "2020-01-29T20:31:42.375Z"
}

Invalid Request (400)

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