Webhooks

Create webhook endpoint

Register a webhook endpoint. Winnr will POST signed event notifications to the URL for every subscribed event type.

The response includes the endpoint's signing secret (whsec_...). Unlike API tokens, the secret can be retrieved again later via GET /v1/webhooks/{webhook_id}/secret.

Maximum 10 endpoints per account.

post/v1/webhooks

Request

  • Base URL: https://api.winnr.app
  • URL: https://api.winnr.app/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

Destination URL. Must be HTTPS.

eventsstring[] required

Event types to subscribe to, or ["*"] for all events

descriptionstring

Optional human-readable label

Example request

{
  "url": "https://example.com/winnr/webhook",
  "events": [
    "message.relayed"
  ],
  "description": "Reply-correlation pipeline"
}

Response

Webhook endpoint created

Example response

{
  "data": {
    "events": [
      "message.relayed"
    ],
    "api_version": "2026-08"
  }
}

Changes

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