---
title: "Update webhook"
method: PATCH
path: "/v3/webhooks/{webhook-id}"
tags: ["Webhooks"]
---

# Update webhook

`PATCH /v3/webhooks/{webhook-id}`

## Request

- Base URL: `https://www.polaraccesslink.com`
- URL: `https://www.polaraccesslink.com/v3/webhooks/{webhook-id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/polar-com/apis/polar-accesslink-api/docs/v3/webhooks/:webhook-id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Edit webhook event types and/or url.

When updating webhook url the AccessLink sends a ping message to the new address. The ping message must be answered with 200 OK or otherwise the webhook is not updated.

## Path parameters

- `webhook-id` string, required

## Request body

- WebhookPatch
  - `events` WebhookType[]: Type of events to subscribe.
  - `url` string, uri: Url where the webhook notification is sent.

## Response `200`

Webhook updated successfully.

- WebhookInfo
  - `data` object[]
    - `id` string: Id of the webhook.
    - `events` WebhookType[]: Subscribed event types.
    - `url` string, uri: Url where the webhook notification is sent.
    - `active` boolean: Is the webhook active.

## Other responses

- `400`: Webhook cannot be updated.
- `404`: Webhook not found.

## Changes

- **2026-11-06** `18ce96365320`: 1 breaking, 7 warning, 8 info
  - removed the enum value `EXERCISE, SLEEP, CONTINUOUS_HEART_RATE, SLEEP_WISE_CIRCADIAN_BEDTIME, SLEEP_WISE_ALERTNESS, ACTIVITY_SUMMARY` of the request property `events/items/`
  - added the new `ACTIVITY_SUMMARY` enum value to the `data/items/events/items/` response property for the response status `200`
  - added the new `CONTINUOUS_HEART_RATE` enum value to the `data/items/events/items/` response property for the response status `200`
  - added the new `EXERCISE` enum value to the `data/items/events/items/` response property for the response status `200`
  - …12 more
- **2026-02-07** `f197848bba31`: 1 breaking, 1 warning, 2 info
  - removed the enum value `EXERCISE, SLEEP, CONTINUOUS_HEART_RATE, SLEEP_WISE_CIRCADIAN_BEDTIME, SLEEP_WISE_ALERTNESS` of the request property `events/items/`
  - added the new `EXERCISE, SLEEP, CONTINUOUS_HEART_RATE, SLEEP_WISE_CIRCADIAN_BEDTIME, SLEEP_WISE_ALERTNESS, ACTIVITY_SUMMARY` enum value to the `data/items/events/items/` response property for the response status `200`
  - added the new `EXERCISE, SLEEP, CONTINUOUS_HEART_RATE, SLEEP_WISE_CIRCADIAN_BEDTIME, SLEEP_WISE_ALERTNESS, ACTIVITY_SUMMARY` enum value to the request property `events/items/`
  - removed the `EXERCISE, SLEEP, CONTINUOUS_HEART_RATE, SLEEP_WISE_CIRCADIAN_BEDTIME, SLEEP_WISE_ALERTNESS` enum value from the `data/items/events/items/` response property for the response status `200`
- …earlier changes not shown

[Operation history](https://skmtc.dev/polar-com/apis/polar-accesslink-api/changes/v3/webhooks/:webhook-id/patch.md)

---

[API](https://skmtc.dev/polar-com/apis/polar-accesslink-api.md) - [All operations](https://skmtc.dev/polar-com/apis/polar-accesslink-api/llms.txt) - [OpenAPI document](https://skmtc.dev/polar-com/apis/polar-accesslink-api/revisions/18ce96365320?raw)