---
title: "POST /ws/subscribe"
method: POST
path: "/ws/subscribe"
tags: ["websocket"]
---

# POST /ws/subscribe

`POST /ws/subscribe`

## Request

- Base URL: `https://api.app.reclaim.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.app.reclaim.ai/ws/subscribe`
- Auth: none declared. Required headers: `connectionId`
- TypeScript: <https://skmtc.dev/reclaim/apis/reclaim-api/docs/ws/subscribe/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `connectionId` string, required

## Request body

- SubscribeAction
  - `subscription` Subscription
    - `subscriptionType` 'Events' | 'CalendarEvents' | 'SyncStatus' | 'DailyHabit' | 'OneOnOne' | 'Task' | 'GtdTaskCache' | 'AssistCompleted' | 'AssistPlanned' | 'NewSubscription' | 'Moment' | 'Quest' | 'ProductUsage' | 'User' | 'Team' | 'SchedulingLink' | 'Analytics' | 'SmartMeeting' | 'SmartHabit' | 'Unsubscribe' | 'AssistantInteraction' | 'UserReset' | 'PipelineMigration' | 'ProactiveGtd' | 'ActionItemCreation' | 'AssistMigration' | 'AssistDowngrade' | 'MeetingHub'
  - `subscriptionId` string

## Response `200`

subscribe 200 response

- WebSocketResponseEnvelope
  - `data` unknown, required
  - `delete` boolean, required
  - `type` 'Events' | 'CalendarEvents' | 'SyncStatus' | 'DailyHabit' | 'OneOnOne' | 'Task' | 'GtdTaskCache' | 'AssistCompleted' | 'AssistPlanned' | 'NewSubscription' | 'Moment' | 'Quest' | 'ProductUsage' | 'User' | 'Team' | 'SchedulingLink' | 'Analytics' | 'SmartMeeting' | 'SmartHabit' | 'Unsubscribe' | 'AssistantInteraction' | 'UserReset' | 'PipelineMigration' | 'ProactiveGtd' | 'ActionItemCreation' | 'AssistMigration' | 'AssistDowngrade' | 'MeetingHub', required
  - `compressed` boolean, required
  - `subscriptionId` string, nullable, required
  - `notificationKeys` string[], required

---

[API](https://skmtc.dev/reclaim/apis/reclaim-api.md) - [All operations](https://skmtc.dev/reclaim/apis/reclaim-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reclaim/apis/reclaim-api/revisions/97270da78302?raw)