Sign in

v1

latestOpenAPI 3.0.02026-07-24622596.0 KB
Webhooks

Create Webhook

post/webhooks

Request body

urlstring
scopesstring[]
enabledboolean
tokenstring

Response

The created webhook

idstring required

A unique ID for the Webhook.

company_idstring

A unique ID for the Company the Webhook belongs to

urlstring

The URL of the webhook, which will receive requests with data for any events fired that fall within the scopes of the Webhook.

scopesstring[]

A list of scopes covering events the Webhook is subscripted to.

tokenstring

A string used to hash the webhook body for verification.

enabledboolean

Whether or not the Webhook is enabled/active.

created_atinteger

Timestamp when the Webhook was created on the server

updated_atinteger

Timestamp when the Webhook was last updated

Example response

{
  "id": "42",
  "company_id": "8675309",
  "url": "https://sweet-webhooks.com/my/webhook/endpoint",
  "scopes": [
    "*"
  ],
  "token": "123456",
  "enabled": true,
  "created_at": 1490737206,
  "updated_at": 1490737406
}