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

NameTypeDescription

Content-Type*

string

The content-type must always be set to application/json.

Authorization*

string

The live or sandbox API key.

Request Body

NameTypeDescription

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.

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

Example request

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"
          ]
        }'

Last updated