Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Reclaim.ai websocket API

The websocket API from Reclaim.ai — 7 operation(s) for websocket.

Reclaim.ai websocket API is one of 83 APIs that Reclaim.ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include websocket. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 117 schemas. It is described by OpenAPI 3.0.1, at version 0.1.

Requests are made against the base URL https://api.app.reclaim.ai.

7 operations 7 paths 117 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.1
Base URL
https://api.app.reclaim.ai
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Reclaim.ai websocket API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Authorization).

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 POST. Each is listed below with its method, path, parameters, and response codes.

websocket 7
POST
/ws-relay
relay 1 param body → 200
POST
/ws/bogus
This is a bogus endpoint that gives us swagger generated objects for our websocket specific classes.
swaggerHelper body → 200
POST
/ws/connect
connect_1 1 param body → 200
POST
/ws/default
defaultHandler → 200
POST
/ws/disconnect
disconnect 1 param → 200
POST
/ws/subscribe
subscribe 1 param body → 200
POST
/ws/unsubscribe
unsubscribe_2 1 param body → 200

Schemas 117

The contract defines 117 schemas that model the data the API accepts and returns. The most detailed are Event (58 properties), AssistSettings (46 properties), User (46 properties), UserSettings (44 properties). Each schema is shown below with its type and property counts.

EventSourceDetails
object
9 properties 9 required
DefaultRsvpAvailability
object
1 property
SchedulingWindowWeeks
string
EventKey
object
2 properties 2 required
WebhookSettings
object
2 properties
MergeDetails
object
4 properties 4 required
UserInterests
object
12 properties
AvailabilitySettings
object
1 property
WebSocketRequestAction
object
UserProfileDepartment
string
Colorized
object
1 property
EventType
string
TaskAutoWorkflowSettings
object
2 properties
RecurringAssignmentType
string
AsanaSettings
object
1 property
TimezonePreference
string
UserProvisioningDetails
object
1 property 1 required
PriorityLevel
string
EventAttendee
object
9 properties 1 required
UserMetadataUsecase
string
ExperimentalSettings
object
2 properties
EventSubType
string
PrioritiesSettings
object
1 property
EventDisplayPreferences
object
9 properties 9 required
SchedulingWindowWeeksOverride
string
UserAccountLock.AccountLockType
string
SignupMethod
string
AssistPlanned
object
4 properties 3 required
UserMetadata
object
9 properties
UserMetadataCompanySize
string
EventResponseStatus
string
CalendarEntrySettings
object
11 properties
DetailedEntitlements
object
14 properties
AssistSettings
object
46 properties
SubscriptionType
string
DayOfWeek
string
AdventureSetting
object
1 property 1 required
AssistNotificationSettings
object
4 properties 4 required
User
object
46 properties 4 required
EventStatus
string
TaskAutoWorkflowType
string
MicrosoftSettings
object
3 properties
GoogleAddOnSettings
object
1 property
UserProfileGoal
string
TimezoneSettings
object
3 properties 1 required
EntitlementDetails
object
3 properties 2 required
ConferenceBufferType
string
UserDateTimeFormatter
object
1 property
AvailabilityType
string
Subscription
object
1 property
SyncFeatureSettings
object
3 properties
AssistType
string
GoogleCalendarEventMetadata
object
3 properties 3 required
SlackStatusSetting
object
4 properties
UserPostOnboard
object
15 properties
AnalyticsSettings
object
2 properties
AutoLock
string
QuestSettings
object
1 property
SchedulingLinkSettings
object
5 properties
DateFieldOrder
string
TaskDefaults
object
13 properties
UserOnboard
object
25 properties
Entitlements
object
18 properties
ColorsSettings
object
5 properties
OrgMetadata.OrgManager
object
3 properties 3 required
Event
object
58 properties 27 required
UserAccountLock
object
2 properties 2 required
SmartSeriesRecurrenceType
string
WebSocketResponseEnvelope
object
6 properties 6 required
CalendarPermissionSettings
object
1 property
TaskSettings
object
6 properties 1 required
AssistDetails
object
This entity maps to the assistevents table.
28 properties
TaskCooldown
string
EventCategory
ThinCalendar
object
6 properties 6 required
SlotScorerVersion
string
ResponseStatus
string
UserProfileRole
string
ReclaimEventType
string
AppNotificationsSettings
object
4 properties
UserSettings
object
44 properties 35 required
FocusSettings
object
2 properties
MeetingType
string
BogusRequest
object
3 properties 3 required
EntitlementValue_Object_
object
3 properties 3 required
RSVPSetting
object
1 property
UnsubscribeAction
object
AssistStatus
string
TodoistSettings
object
1 property
Settings
object
8 properties
OrgMetadata
object
7 properties
UserPostOnboardState
string
AssistCompleted
object
Notification for websocket clients.
4 properties 3 required
SubscribeAction
object
DropboxSettings
object
1 property
SlackOutsideHoursSetting
object
3 properties 2 required
BillingSettings
object
1 property
UserAdventures
object
1 property
SchedulingLinkNameVisibility
string
SlackSettings.StatusSync
string
ProjectsSettings
object
1 property
SmartOneOnOneSettings
object
1 property
EventColor
string
PrioritySource
string
ScheduleAssistantScoringSettings
object
1 property
ReclaimEdition
string
SlackSettings
object
19 properties
ObservedUser
object
TemporalSettings
object
1 property
CalendarSettings
object
2 properties
LockState
string
LogContext
object
AssistPolicyOverride
object
6 properties 6 required
MergeDetails.EventType
string
PlatformEventType
string
ScheduleAssistantSettings
object
10 properties
WeeklyReport
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reclaim-ai-websocket-api-openapi.yml Raw ↑

Other APIs Reclaim.ai publishes across the network.

Reclaim.ai account-time-schemes API
Reclaim.ai accounts API
Reclaim.ai action-items API
Reclaim.ai actions API
Reclaim.ai Admin API
Reclaim.ai analytics API
Reclaim.ai Anonymous API
Reclaim.ai api-management API
Reclaim.ai asana API
Reclaim.ai assist API
Reclaim.ai Assistant API
Reclaim.ai Avatar API