> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctechnology.io/llms.txt > Use this file to discover all available pages before exploring further. # Notification > Receive messages that describe notifications passed to the user. They can have different priorities (e.g., to trigger popups with different colors or of different "invasiveness"). ## AsyncAPI ````yaml asyncapi-reference/asyncapi.yml notification id: notification title: Notification description: > Receive messages that describe notifications passed to the user. They can have different priorities (e.g., to trigger popups with different colors or of different "invasiveness"). servers: - id: production-ws protocol: wss host: api.ctechnology.io bindings: [] variables: [] - id: playground-ws protocol: wss host: api.playground.ctechnology.io bindings: [] variables: [] address: notification parameters: [] bindings: [] operations: - &ref_0 id: receiveNotification title: Receive notification description: Receive user notifications type: receive messages: - &ref_1 id: Notification contentType: application/json payload: - name: Notification type: object properties: - name: header type: object title: Application Header description: > Headers sent with all messages. They contain meta information about the data being sent. required: false properties: - name: type type: string description: > The type of message being sent, currently only coming from the API. enumValues: - API required: false - name: api_version type: string description: | The API version this message corresponds to. required: false - name: channel type: string description: > The channel for which this data is being sent. Usually of the form `group/object`. required: false - name: uri type: string description: > An URI that identifies the data being sent. Usually, this is an URL that corresponds to a REST endpoint, where exactly the same data can be retrieved. required: false - name: data type: object title: Notification description: | A notification that was generated for / sent to a user. required: false properties: - name: id type: string description: A unique ID identifying this notification. required: true - name: vehicle_id type: string description: > The ID of the vehicle for which this notification was generated. This might be empty if it is a notification that is not related to any vehicle. required: false - name: action_id type: string description: > Many notifications are generated alongside vehicle actions. If this is the case, the respective action is referenced here. required: false - name: timestamp type: string description: The timestamp at which this notification was generated. required: true - name: type type: string description: > The type of this notification. The following notifications are available: - `VEHICLE_MOV`: Vehicle moved from current position. - `VEHICLE_MOV_ACC`: Vehicle moved based on the accelerometer sensing capability. - `VEHICLE_MOV_TOW`: Vehicle moved based on the "tow" sensing capability. This means the accelerometer detected a stronger movement. enumValues: - VEHICLE_MOV - VEHICLE_MOV_ACC - VEHICLE_MOV_TOW - SZ_ENTER - ISZ_ENTER - OSZ_ENTER - SZ_LEAVE - ISZ_LEAVE - OSZ_LEAVE - SZ_EXSPEED - ISZ_EXSPEED - OSZ_EXSPEED - HARBOR_ENTER - HARBOR_LEAVE - STAYPOINT_ENTER - STAYPOINT_LEAVE - TRIPLEG_START - TRIPLEG_END - TRIP_START - TRIP_STOP - TRIP_CONTINUE - TRIP_COMPLETE - JOURNEY_START - JOURNEY_STOP - JOURNEY_CONTINUE - JOURNEY_COMPLETE - LLV_NC_LT - LLV_DISC - LLV_CONN - IGNITION_ON - IGNITION_OFF - DIST_REM_CRIT - TEMP_CRIT - REFUEL - FUEL_LOW_RET - BAT_LOW - BAT_DISC - USER_BAT_V - USER_BAT_PCT - USER_FUEL_PCT - USER_TEMP - USER_TEMP_1 - USER_TEMP_2 - USER_TEMP_3 - USER_TEMP_4 - USER_HARBOR_DIST - USER_SHORE_DIST - USER_GEOFENCE_ENTER - USER_GEOFENCE_LEAVE - USER_STAYPOINT_DIST - WATER_IN - WATER_OUT - MAINTENANCE - NEW_TICKET - NEW_MESSAGE_FOR_USER - NEW_MESSAGE_FOR_ORG required: true - name: priority type: string description: > The priority of this message, where `ALERT` is usually pushed via high priority to a user's smartphone, `HIGH` leads to a popup on the user's desktop OS and web dashboard (and app), `MEDIUM` solely a popup within the web dashboard (and app, if open), and `LOW` simply sets the "bell" to read, indicating that there is a new notification. enumValues: - ALERT - HIGH - MEDIUM - LOW required: true - name: title type: string description: >- The title that should be displayed to a user, in his/her preferred language. required: true - name: message type: string description: >- The message that should be displayed to a user, in his/her preferred language. required: true - name: description type: string description: >- Potential additional data that can be used to display the notification. required: false - name: readOnly type: boolean required: false - name: read type: boolean description: Denotes if this notification is marked as "read" or not. required: true headers: [] jsonPayloadSchema: type: object properties: header: type: object title: Application Header description: > Headers sent with all messages. They contain meta information about the data being sent. properties: type: type: string description: > The type of message being sent, currently only coming from the API. enum: - API x-parser-schema-id: api_version: type: string description: | The API version this message corresponds to. x-parser-schema-id: channel: type: string description: > The channel for which this data is being sent. Usually of the form `group/object`. x-parser-schema-id: uri: type: string format: uri description: > An URI that identifies the data being sent. Usually, this is an URL that corresponds to a REST endpoint, where exactly the same data can be retrieved. x-parser-schema-id: x-parser-schema-id: ApplicationHeader data: type: object title: Notification description: | A notification that was generated for / sent to a user. required: - id - timestamp - type - priority - title - message - data - read properties: id: type: string description: A unique ID identifying this notification. readOnly: true x-parser-schema-id: vehicle_id: type: string nullable: true description: > The ID of the vehicle for which this notification was generated. This might be empty if it is a notification that is not related to any vehicle. readOnly: true x-parser-schema-id: action_id: type: string nullable: true description: > Many notifications are generated alongside vehicle actions. If this is the case, the respective action is referenced here. readOnly: true x-parser-schema-id: timestamp: type: string format: date-time description: The timestamp at which this notification was generated. readOnly: true x-parser-schema-id: type: type: string description: > The type of this notification. The following notifications are available: - `VEHICLE_MOV`: Vehicle moved from current position. - `VEHICLE_MOV_ACC`: Vehicle moved based on the accelerometer sensing capability. - `VEHICLE_MOV_TOW`: Vehicle moved based on the "tow" sensing capability. This means the accelerometer detected a stronger movement. readOnly: true enum: - VEHICLE_MOV - VEHICLE_MOV_ACC - VEHICLE_MOV_TOW - SZ_ENTER - ISZ_ENTER - OSZ_ENTER - SZ_LEAVE - ISZ_LEAVE - OSZ_LEAVE - SZ_EXSPEED - ISZ_EXSPEED - OSZ_EXSPEED - HARBOR_ENTER - HARBOR_LEAVE - STAYPOINT_ENTER - STAYPOINT_LEAVE - TRIPLEG_START - TRIPLEG_END - TRIP_START - TRIP_STOP - TRIP_CONTINUE - TRIP_COMPLETE - JOURNEY_START - JOURNEY_STOP - JOURNEY_CONTINUE - JOURNEY_COMPLETE - LLV_NC_LT - LLV_DISC - LLV_CONN - IGNITION_ON - IGNITION_OFF - DIST_REM_CRIT - TEMP_CRIT - REFUEL - FUEL_LOW_RET - BAT_LOW - BAT_DISC - USER_BAT_V - USER_BAT_PCT - USER_FUEL_PCT - USER_TEMP - USER_TEMP_1 - USER_TEMP_2 - USER_TEMP_3 - USER_TEMP_4 - USER_HARBOR_DIST - USER_SHORE_DIST - USER_GEOFENCE_ENTER - USER_GEOFENCE_LEAVE - USER_STAYPOINT_DIST - WATER_IN - WATER_OUT - MAINTENANCE - NEW_TICKET - NEW_MESSAGE_FOR_USER - NEW_MESSAGE_FOR_ORG x-parser-schema-id: priority: type: string description: > The priority of this message, where `ALERT` is usually pushed via high priority to a user's smartphone, `HIGH` leads to a popup on the user's desktop OS and web dashboard (and app), `MEDIUM` solely a popup within the web dashboard (and app, if open), and `LOW` simply sets the "bell" to read, indicating that there is a new notification. readOnly: true enum: - ALERT - HIGH - MEDIUM - LOW x-parser-schema-id: title: type: string description: >- The title that should be displayed to a user, in his/her preferred language. readOnly: true x-parser-schema-id: message: type: string description: >- The message that should be displayed to a user, in his/her preferred language. readOnly: true x-parser-schema-id: data: description: >- Potential additional data that can be used to display the notification. readOnly: true x-parser-schema-id: read: type: boolean description: Denotes if this notification is marked as "read" or not. x-parser-schema-id: x-parser-schema-id: Notification x-parser-schema-id: title: Notification example: |- { "header": { "type": "", "api_version": "", "channel": "", "uri": "" }, "data": { "id": "", "vehicle_id": "", "action_id": "", "timestamp": "", "type": "", "priority": "", "title": "", "message": "", "description": "", "readOnly": true, "read": true } } bindings: [] extensions: - id: x-parser-unique-object-id value: Notification - id: x-parser-message-name value: Notification bindings: [] extensions: - id: x-parser-unique-object-id value: notification sendOperations: - *ref_0 receiveOperations: [] sendMessages: - *ref_1 receiveMessages: [] extensions: - id: x-parser-unique-object-id value: notification securitySchemes: [] ````