Update a webhook

URL

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

Updates the specified webhook by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Headers

NameTypeDescription

Content-Type*

string

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

Authorization*

string

The API live or test key.

Path parameters

NameTypeDescription

id*

string

The ID of the webhook.

Body

NameTypeDescription

url

string

URL of the webhook.

description

string

An optional description of what the webhook is used for.

enabled

string

Determines whether the webhook should be active.

events

string

The list of event types for which the event is subscribed

Example request

curl -X POST https://api.complycube.com/v1/webhooks \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          "id": "WEBHOOK_ID",
          "description": "updated description"
        }'

Example response

{
  "id": "5ed1712e99c81a0007b9a3d6",
  "description": "Updated description",
  "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:32:22.000Z"
}

Last updated