webhooks

Create webhook subscription

Subscribe an https endpoint to events. The API returns the signing secret only in this answer; an owner can show it again in the dashboard after a password check.

Store the secret: the API returns it only in this answer. An owner or admin can show it again in the dashboard (Developers → Webhooks, Show secret) after confirming it's them.

A retry with the same Idempotency-Key returns the same webhook without its secret field: the secret is shown once. If the first response was lost, rotate it, or have an owner show it again in the dashboard.

PATCH /api/v1/webhooks/{id} updates url/events/is_active, or pass rotate_secret: true to issue a new signing secret.

DELETE /api/v1/webhooks/{id} removes the subscription.

post/api/v1/webhooks

Request

Base URL: https://app.blueticked.com
URL: https://app.blueticked.com/api/v1/webhooks
Auth: HTTP bearer

Headers

Idempotency-Keystring

A unique key (e.g. a UUID) that makes a POST safe to retry: replaying the same key within 24h returns the original result instead of acting twice.

Request body

urlstring required

eventsstring[] required

descriptionstring

Example request

{
  "url": "https://api.example.com/blueticked/events",
  "events": [
    "message.delivered"
  ],
  "description": "Production event handler"
}

Response

Success

request_idstring required

Example response

{
  "webhook": {
    "id": "9a342329-d651-4da0-a2d6-b24e4d3599b5",
    "url": "https://api.example.com/blueticked/events",
    "events": [
      "message.delivered"
    ],
    "is_active": true,
    "secret": "whsec_..."
  },
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.