> ## Documentation Index > Fetch the complete documentation index at: https://api-documentation.kare-app.fr/llms.txt > Use this file to discover all available pages before exploring further. # Ws ## AsyncAPI ````yaml api/rs/asyncapi.json ws id: ws title: Ws description: '' servers: - id: local protocol: ws host: localhost:3000 bindings: [] variables: [] address: /rs/ws parameters: [] bindings: [] operations: - &ref_2 id: sendToClient title: Send to client type: send messages: - &ref_3 id: notification payload: - name: notification type: object properties: - name: v type: number description: 1 required: true - name: id type: string required: true - name: ts type: string required: true - name: type type: string description: notification required: true - name: data type: object required: true properties: - name: id type: string required: true - name: type type: string enumValues: - deadline_reminder - deadline_overdue - commission_reminder - inbox_report_received - conversation_message_received - intervention_started - intervention_signed - intervention_planned - intervention_overdue - user_action required: true - name: severity type: string enumValues: - alert - reminder - info required: true - name: expectation type: string enumValues: - required - suggested - none required: true - name: action type: string required: true - name: title type: string required: true - name: body type: string required: true - name: payload type: object required: true - name: channels type: array required: true properties: - name: item type: string enumValues: - in_app - email - sms required: false - name: subjectType type: string required: true - name: subjectId type: string required: true - name: subjectLabel type: string required: true - name: readAt type: string required: true - name: pinnedAt type: string required: true - name: createdAt type: string required: true - name: updatedAt type: string required: true headers: [] jsonPayloadSchema: type: object properties: v: type: number const: 1 x-parser-schema-id: id: type: string x-parser-schema-id: ts: type: string x-parser-schema-id: type: type: string const: notification x-parser-schema-id: data: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ x-parser-schema-id: type: type: string enum: - deadline_reminder - deadline_overdue - commission_reminder - inbox_report_received - conversation_message_received - intervention_started - intervention_signed - intervention_planned - intervention_overdue - user_action x-parser-schema-id: severity: type: string enum: - alert - reminder - info x-parser-schema-id: expectation: type: string enum: - required - suggested - none x-parser-schema-id: action: anyOf: - type: string enum: - plan - reschedule - verify - process - prepare x-parser-schema-id: - type: 'null' x-parser-schema-id: properties: {} x-parser-schema-id: title: type: string minLength: 1 maxLength: 200 x-parser-schema-id: body: anyOf: - type: string maxLength: 2000 x-parser-schema-id: - type: 'null' x-parser-schema-id: properties: {} x-parser-schema-id: payload: anyOf: - type: object propertyNames: type: string x-parser-schema-id: properties: {} x-parser-schema-id: - type: 'null' x-parser-schema-id: properties: {} x-parser-schema-id: channels: type: array items: type: string enum: - in_app - email - sms x-parser-schema-id: x-parser-schema-id: subjectType: anyOf: - type: string enum: - Anomaly - AnomalyIntervention - BoUser - Building - BuildingWork - Comment - Commission - Compliance - Contact - Contract - ContractDocument - Conversation - Diploma - Document - EmailSenderRule - Equipment - EquipmentSpecification - Folder - FormSubmission - FormTemplate - Identity - InboxItem - InboxMail - Intervention - InterventionLink - Label - LibraryAnomaly - LibraryEquipmentSpecification - LibraryLabel - LibraryRole - LibraryRule - LibraryTechnicalInstallation - DocumentExport - Logbook - Notification - NotificationPreference - Organization - Plan - PlanItem - Project - ProjectFolder - Provider - ProviderAccess - PrUser - QrCode - QrCodeGeneration - Report - ReportAnalysis - Responsibility - Role - Routine - Rule - SelectionPerimeter - TagType - TechnicalInstallation - Unit - User x-parser-schema-id: - type: 'null' x-parser-schema-id: properties: {} x-parser-schema-id: subjectId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ x-parser-schema-id: - type: 'null' x-parser-schema-id: properties: {} x-parser-schema-id: subjectLabel: anyOf: - type: string minLength: 1 maxLength: 200 x-parser-schema-id: - type: 'null' x-parser-schema-id: properties: {} x-parser-schema-id: readAt: anyOf: - type: string format: date-time x-parser-schema-id: - type: 'null' x-parser-schema-id: properties: {} x-parser-schema-id: pinnedAt: anyOf: - type: string format: date-time x-parser-schema-id: - type: 'null' x-parser-schema-id: properties: {} x-parser-schema-id: createdAt: type: string format: date-time x-parser-schema-id: updatedAt: type: string format: date-time x-parser-schema-id: required: - id - type - severity - expectation - action - title - body - payload - channels - subjectType - subjectId - subjectLabel - readAt - pinnedAt - createdAt - updatedAt x-parser-schema-id: required: - v - id - ts - type - data x-parser-schema-id: title: Notification example: No examples found bindings: [] extensions: - id: x-parser-unique-object-id value: notification - &ref_4 id: system payload: - name: system type: object properties: - name: v type: number description: 1 required: true - name: id type: string required: true - name: ts type: string required: true - name: type type: string description: system required: true - name: data type: object required: true properties: - name: event type: string description: pong required: true - name: event type: string description: error required: true - name: code type: string required: true - name: message type: string required: true - name: event type: string description: reconnect required: true - name: reason type: string description: capabilities required: true headers: [] jsonPayloadSchema: type: object properties: v: type: number const: 1 x-parser-schema-id: id: type: string x-parser-schema-id: ts: type: string x-parser-schema-id: type: type: string const: system x-parser-schema-id: data: oneOf: - type: object properties: event: type: string const: pong x-parser-schema-id: required: - event x-parser-schema-id: - type: object properties: event: type: string const: error x-parser-schema-id: code: type: string x-parser-schema-id: message: type: string x-parser-schema-id: required: - event - code - message x-parser-schema-id: - type: object properties: event: type: string const: reconnect x-parser-schema-id: reason: type: string const: capabilities x-parser-schema-id: required: - event - reason x-parser-schema-id: properties: {} x-parser-schema-id: required: - v - id - ts - type - data x-parser-schema-id: title: System example: |- { "v": 123, "id": "", "ts": "", "type": "", "data": { "event": "", "code": "", "message": "", "reason": "" } } bindings: [] extensions: - id: x-parser-unique-object-id value: system - &ref_5 id: job payload: - name: job type: object properties: - name: v type: number description: 1 required: true - name: id type: string required: true - name: ts type: string required: true - name: type type: string description: job required: true - name: data type: object required: true properties: - name: jobId type: string required: true - name: kind type: string required: true - name: status type: string enumValues: - queued - running - succeeded - failed - cancelled required: true - name: progress type: number required: false - name: startedAt type: string required: false - name: error type: string required: false headers: [] jsonPayloadSchema: type: object properties: v: type: number const: 1 x-parser-schema-id: id: type: string x-parser-schema-id: ts: type: string x-parser-schema-id: type: type: string const: job x-parser-schema-id: data: type: object properties: jobId: type: string x-parser-schema-id: kind: type: string x-parser-schema-id: status: type: string enum: - queued - running - succeeded - failed - cancelled x-parser-schema-id: progress: type: number minimum: 0 maximum: 100 x-parser-schema-id: startedAt: type: string x-parser-schema-id: error: type: string x-parser-schema-id: required: - jobId - kind - status x-parser-schema-id: required: - v - id - ts - type - data x-parser-schema-id: title: Job example: |- { "v": 123, "id": "", "ts": "", "type": "", "data": { "jobId": "", "kind": "", "status": "", "progress": 123, "startedAt": "", "error": "" } } bindings: [] extensions: - id: x-parser-unique-object-id value: job - &ref_6 id: entity payload: - name: entity type: object properties: - name: v type: number description: 1 required: true - name: id type: string required: true - name: ts type: string required: true - name: type type: string description: entity required: true - name: data type: object required: true properties: - name: entity type: string enumValues: - Anomaly - AnomalyIntervention - BoUser - Building - BuildingWork - Comment - Commission - Compliance - Contact - Contract - ContractDocument - Conversation - Diploma - Document - EmailSenderRule - Equipment - EquipmentSpecification - Folder - FormSubmission - FormTemplate - Identity - InboxItem - InboxMail - Intervention - InterventionLink - Label - LibraryAnomaly - LibraryEquipmentSpecification - LibraryLabel - LibraryRole - LibraryRule - LibraryTechnicalInstallation - DocumentExport - Logbook - Notification - NotificationPreference - Organization - Plan - PlanItem - Project - ProjectFolder - Provider - ProviderAccess - PrUser - QrCode - QrCodeGeneration - Report - ReportAnalysis - Responsibility - Role - Routine - Rule - SelectionPerimeter - TagType - TechnicalInstallation - Unit - User required: true - name: action type: string required: true - name: id type: string required: true - name: orgId type: string required: true headers: [] jsonPayloadSchema: type: object properties: v: type: number const: 1 x-parser-schema-id: id: type: string x-parser-schema-id: ts: type: string x-parser-schema-id: type: type: string const: entity x-parser-schema-id: data: type: object properties: entity: type: string enum: - Anomaly - AnomalyIntervention - BoUser - Building - BuildingWork - Comment - Commission - Compliance - Contact - Contract - ContractDocument - Conversation - Diploma - Document - EmailSenderRule - Equipment - EquipmentSpecification - Folder - FormSubmission - FormTemplate - Identity - InboxItem - InboxMail - Intervention - InterventionLink - Label - LibraryAnomaly - LibraryEquipmentSpecification - LibraryLabel - LibraryRole - LibraryRule - LibraryTechnicalInstallation - DocumentExport - Logbook - Notification - NotificationPreference - Organization - Plan - PlanItem - Project - ProjectFolder - Provider - ProviderAccess - PrUser - QrCode - QrCodeGeneration - Report - ReportAnalysis - Responsibility - Role - Routine - Rule - SelectionPerimeter - TagType - TechnicalInstallation - Unit - User x-parser-schema-id: action: type: string x-parser-schema-id: id: anyOf: - type: string x-parser-schema-id: - type: 'null' x-parser-schema-id: properties: {} x-parser-schema-id: orgId: type: string x-parser-schema-id: required: - entity - action - id - orgId x-parser-schema-id: required: - v - id - ts - type - data x-parser-schema-id: title: Entity example: |- { "v": 123, "id": "", "ts": "", "type": "", "data": { "entity": "", "action": "", "id": "", "orgId": "" } } bindings: [] extensions: - id: x-parser-unique-object-id value: entity bindings: [] extensions: &ref_0 - id: x-parser-unique-object-id value: ws - &ref_1 id: receiveFromClient title: Receive from client type: receive messages: [] bindings: [] extensions: *ref_0 sendOperations: - *ref_1 receiveOperations: - *ref_2 sendMessages: [] receiveMessages: - *ref_3 - *ref_4 - *ref_5 - *ref_6 extensions: - id: x-parser-unique-object-id value: ws securitySchemes: [] ````