---
title: "Create webhook"
method: POST
path: "/v3/webhooks"
tags: ["Webhooks"]
---

# Create webhook

`POST /v3/webhooks`

## Request

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

Create new webhook.

When creating webhook the AccessLink sends a ping message to the url in request body. The ping message must be answered with 200 OK or otherwise the webhook is not created.

Created webhook is by default in activated state and will send push notifications about subscribed events. Webhook will be automatically deactivated if push notifications have not been successful for a period of seven (7) days.
**Note!** Save the *signature_secret_key* from response since this is the only chance to get it.

## Request body

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

## Response `201`

Created webhook.

- CreatedWebhook
  - `data` object
    - `id` string: Id of the new webhook.
    - `events` WebhookType[]: Subscribed event types.
    - `url` string, uri: Url where the webhook notification is sent.
    - `signature_secret_key` string: Signing key for verifying that sender is actually Polar.

## Other responses

- `400`: Webhook cannot be created.
- `409`: Webhook already exists.

## 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/events/items/` response property for the response status `201`
  - added the new `CONTINUOUS_HEART_RATE` enum value to the `data/events/items/` response property for the response status `201`
  - added the new `EXERCISE` enum value to the `data/events/items/` response property for the response status `201`
  - …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/events/items/` response property for the response status `201`
  - 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/events/items/` response property for the response status `201`
- …earlier changes not shown

[Operation history](https://skmtc.dev/polar-com/apis/polar-accesslink-api/changes/v3/webhooks/post.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)