Create a webhook endpoint

POST/webhooksNeedsworkspace.settings

The signing secret is returned only here (and when you rotate it). Store it to verify Cueston-Signature.

Authorization

secretKey

headerAuthorizationBearer <sk_…>

A secret API key from Settings → API keys. It acts with its creator's role.

Request Body

application/json

body

url*string

Length1 <= length <= 2048

events*array<>

Items1 <= items <= 9

description?|null

Response Body

Created

application/json

response

webhook*

secret*string

whsec_… signing secret. Shown once.

Shell

curl -X POST 'https://app.cueston.com/api/webhooks' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://app.acme.com/settings/billing",
  "events": [
    "content.published"
  ]
}'curl -X POST 'https://app.cueston.com/api/webhooks' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://app.acme.com/settings/billing",
  "events": [
    "content.published"
  ]
}'

Example ResponseSchema

JSON

{
  "webhook": {
    "id": 42,
    "url": "https://app.acme.com/settings/billing",
    "description": "string",
    "events": [
      "string"
    ],
    "active": true,
    "disabledReason": "string",
    "disabledAt": "2026-10-26T09:30:00Z",
    "failingSince": "2026-10-26T09:30:00Z",
    "lastSuccessAt": "2026-10-26T09:30:00Z",
    "lastFailureAt": "2026-10-26T09:30:00Z",
    "secretHint": "whsec_9vY2…",
    "previousSecretExpiresAt": "2026-10-26T09:30:00Z",
    "createdAt": "2026-10-26T09:30:00Z",
    "updatedAt": "2026-10-26T09:30:00Z"
  },
  "secret": "whsec_9vY2kQ…"
}{
  "webhook": {
    "id": 42,
    "url": "https://app.acme.com/settings/billing",
    "description": "string",
    "events": [
      "string"
    ],
    "active": true,
    "disabledReason": "string",
    "disabledAt": "2026-10-26T09:30:00Z",
    "failingSince": "2026-10-26T09:30:00Z",
    "lastSuccessAt": "2026-10-26T09:30:00Z",
    "lastFailureAt": "2026-10-26T09:30:00Z",
    "secretHint": "whsec_9vY2…",
    "previousSecretExpiresAt": "2026-10-26T09:30:00Z",
    "createdAt": "2026-10-26T09:30:00Z",
    "updatedAt": "2026-10-26T09:30:00Z"
  },
  "secret": "whsec_9vY2kQ…"
}