Webhooks

Endpoints for managing webhooks that receive real-time event notifications.

GET/api/v1/settings/webhooks

List all webhooks for the authenticated user.

Authentication

Authentication required (any valid API key)

POST/api/v1/settings/webhooks

Create a new webhook. HTTPS URLs only.

Authentication

settings:write

Request Body

{
  "name": "Discord Notify",
  "url": "https://example.com/webhook",
  "secret": "optional-signing-secret",
  "notifyOnQuestionReceived": true,
  "notifyOnAnswerSent": false
}
PUT/api/v1/settings/webhooks/:id

Update an existing webhook.

Authentication

settings:write

Request Body

{
  "name": "Updated Name",
  "url": "https://example.com/webhook",
  "secret": "new-secret",
  "notifyOnQuestionReceived": true,
  "notifyOnAnswerSent": true,
  "isActive": true
}

Fields not included in the request body are left unchanged.

DELETE/api/v1/settings/webhooks/:id

Delete a webhook.

Authentication

settings:write
GET/api/v1/settings/webhooks/:id/deliveries

Get the last 50 delivery logs for the specified webhook.

Authentication

Authentication required (any valid API key)

Response

{
  "logs": [
    {
      "id": "...",
      "eventType": "QUESTION_RECEIVED",
      "success": true,
      "statusCode": 200,
      "error": null,
      "attemptedAt": "2026-02-14T00:00:00.000Z"
    },
    ...
  ]
}
POST/api/v1/settings/webhooks/test

Send a test payload to a webhook URL.

Authentication

settings:write

Request Body

{
  "url": "https://example.com/webhook",
  "secret": "optional-signing-secret"
}

Payload Format

Webhook payloads are sent as POST requests with a JSON body.

{
  "type": "QUESTION_RECEIVED",
  "timestamp": "2026-02-14T00:00:00.000Z",
  "data": { ... }
}

Signature Verification

When a secret is configured, each request includes an X-Hub-Signature header containing an HMAC-SHA256 signature of the raw request body.

X-Hub-Signature: sha256=<hmac-hex>