Webhooks

Create webhook

Register a new webhook endpoint. The signing secret is only returned once at creation time. Max 5 webhooks per user.

Events:

  • session.completed — fires once, after a session finishes processing and the summary, notes, and tags are queryable. This is the "session is ready to use" event.
  • session.updated — session metadata was changed (title, summary, notes, tags, favorite). Fires for edits from any source: the API, mobile app, or web app.
  • session.action_items.updated — structured action items on a session were written or edited via PATCH. Carries the full session in data.session, including the new action_items and action_items_version.
  • session.deleted — session was deleted (soft-delete or hard-delete of a completed session).
post/v1/webhooks

Request

  • Base URL: https://api.wave.co
  • URL: https://api.wave.co/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
eventsWebhookEventType[] required

Example request

{
  "url": "https://example.com/wave/webhook",
  "events": [
    "session.completed",
    "session.updated"
  ]
}

Response

Webhook created (includes secret)

idstring required
urlstring required
eventsWebhookEventType[] required
activeboolean required
failure_countnumber required
last_delivery_atstring nullable required
last_delivery_statusnumber nullable required
created_atstring required
updated_atstring required
secretstring

Example response

{
  "id": "wh_01HX4R7MT8PQZ6VCN9ABYF2KJM",
  "url": "https://example.com/wave/webhook",
  "events": [
    "session.completed",
    "session.updated"
  ],
  "active": true,
  "failure_count": 0,
  "last_delivery_at": "2025-04-21T15:02:11.000Z",
  "last_delivery_status": 200,
  "created_at": "2025-04-20T18:32:14.000Z",
  "updated_at": "2025-04-21T15:02:11.000Z",
  "secret": "whsec_7j3LxGf9qA2pRn5bXcV1MdKt"
}

Changes

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