Webhooks

Update webhook

Update webhook URL, events, or active status.

patch/v1/webhooks/{id}

Request

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

Path parameters

idstring required

Webhook ID

Example:wh_01HX4R7MT8PQZ6VCN9ABYF2KJM

Request body

urlstring uri
eventsWebhookEventType[]
activeboolean

Example request

{
  "events": [
    "session.completed",
    "session.updated",
    "session.deleted"
  ],
  "active": true
}

Response

Webhook updated

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.