> ## 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. # Vehicle action > Receive messages that describe actions that happen with a given vehicle. In contrast to notifications (that are generated when a user specifically requests it), actions are sent via this channel independently if a user wants to be notified or not. ## AsyncAPI ````yaml asyncapi-reference/asyncapi.yml vehicleAction id: vehicleAction title: Vehicle action description: > Receive messages that describe actions that happen with a given vehicle. In contrast to notifications (that are generated when a user specifically requests it), actions are sent via this channel independently if a user wants to be notified or not. 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: vehicle/action parameters: [] bindings: [] operations: - &ref_0 id: receiveVehicleAction title: Receive vehicle action description: Receive vehicle actions type: receive messages: - &ref_1 id: VehicleAction contentType: application/json payload: - name: VehicleAction 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: Vehicle Action description: > Anything that happened with a given vehicle at a particular point in time. required: false properties: - name: id type: string description: A unique identifier for this action. required: true - name: vehicle_id type: string description: The ID of the vehicle this action is for. required: true - name: user_id type: string description: >- The ID of the user for which this action was generated (if any). required: false - name: trip_id type: string description: >- The ID of the trip during which this action was generated (if any). required: true - name: timestamp type: string description: The date/time at which this action was generated.fdfd required: true - name: type type: string description: > The type of action: - `VEHICLE_MOV`: Vehicle starts moving (e.g., away from home location/harbor). - `VEHICLE_MOV_ACC`: Vehicle starts moving (as detected by accelerometer). - `VEHICLE_MOV_TOW`: Vehicle starts moving (as indicated via CAN bus). - `SZ_ENTER`: Vehicle enters shore zone (boats). - `ISZ_ENTER`: Vehicle enters inner shore zone (boats). - `OSZ_ENTER`: Vehicle enters outer shore zone (boats). - `SZ_LEAVE`: Vehicle leaves shore zone (boats). - `ISZ_LEAVE`: Vehicle leaves inner shore zone (boats). - `OSZ_LEAVE`: Vehicle leaves outer shore zone (boats). - `SZ_EXSPEED`: Vehicle exceeds speed limit in shore zone (boats). - `ISZ_EXSPEED`: Vehicle exceeds speed limit in inner shore zone (boats). - `OSZ_EXSPEED`:Vehicle exceeds speed limit in outer shore zone (boats). - `HOME_LOCATION_ENTER`: Vehicle enters home location / harbor. - `HOME_LOCATION_LEAVE`: Vehicle leaves home location / harbor. - `STAYPOINT_ENTER`: Vehicle enters a new staypoint (point where it stays for a longer time). - `STAYPOINT_LEAVE`: Vehicle leaves staypoint (point where it stays for a longer time). - `TRIPLEG_START`: Tripleg starts (part of a larger trip between two staypoints). - `TRIPLEG_END`: Tripleg ends. - `TRIP_START`: Trip starts (sequence of multiple triplegs driven in a certain timeframe). - `TRIP_STOP`: Trip stops. This can be a temporary stop, i.e., the trip might be continued. - `TRIP_CONTINUE`: Trip continues. - `TRIP_COMPLETE`: Trip is complete. This action might be generated quite a while after the trip stops due to the time it takes to detect it. - `JOURNEY_START`: Journey starts (a journey is a trip from one home location / harbor to another). - `JOURNEY_STOP`: Journey stops (might be continued). - `JOURNEY_CONTINUE`: Journey continues. - `JOURNEY_COMPLETE`: Jorney is complete. This action might be generated quite a while after the trip stops due to the time it takes to detect it. - `LLV_NC_LT`: Low temperature was detected while no landline is connected. - `LLV_DISC`: Landline (220V) is disconnected. - `LLV_CONN`: Landline (220V) is connected. - `IGNITION_ON`: Ignition is turned on. - `IGNITION_OFF`: Ignition is turned off. - `DIST_REM_CRIT`: The remaining distance is critical. It is recommended to refuel soon. - `TEMP_CRIT`: The (ambient/outdoor) temperature is critical. - `REFUEL`: The vehicle was refueled. - `FUEL_LOW_RET`: The fuel is not 100% when returning to a home location / harbor. - `BAT_LOW`: The battery is low. - `BAT_DISC`: The battery was disconnected. - `USER_BAT_V`: The battery is above / below a user-defined threshold (V). - `USER_BAT_PCT`: The battery is above / below a user-defined threshold (%). - `USER_FUEL_PCT`: The fuel is above / below a user-defined threshold (%). - `USER_TEMP`: The temperature is above / below a user-defined threshold (°C). - `USER_TEMP_1`: Temperature 1 is above / below a user-defined threshold (°C). - `USER_TEMP_2`: Temperature 2 is above / below a user-defined threshold (°C). - `USER_TEMP_3`: Temperature 3 is above / below a user-defined threshold (°C). - `USER_TEMP_4`: Temperature 4 is above / below a user-defined threshold (°C). - `USER_HOME_LOCATION_DIST`: The distance to the home location / harbor is above / below a user-defined threshold (m). - `USER_SHORE_DIST`: The distance to the shore is above / below a user-defined threshold (m). - `USER_GEOFENCE_ENTER`: The vehicle enters a user-defined geofence. - `USER_GEOFENCE_LEAVE`: The vehicle leaves a user-defined geofence. - `USER_STAYPOINT_DIST`: The distance to the last staypoint is above a user-defined threshold (m). - `WATER_IN`: The vehicle was put into the water (boats). - `WATER_OUT`: The vehicle was taken out of the water (boats). - `MAINTENANCE`: A maintenance event reached a critical threshold. - `NEW_TICKET`: A new ticket was created by a user. required: true - name: message type: string description: The message corresponding to the action type. required: true - name: data type: object description: >- Additional data that is used to describe the action in more detail. 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: Vehicle Action description: > Anything that happened with a given vehicle at a particular point in time. required: - id - vehicle_id - trip_id - timestamp - type - data - message properties: id: type: string description: A unique identifier for this action. readOnly: true x-parser-schema-id: vehicle_id: type: string description: The ID of the vehicle this action is for. readOnly: true x-parser-schema-id: user_id: type: string nullable: true description: >- The ID of the user for which this action was generated (if any). readOnly: true x-parser-schema-id: trip_id: type: string nullable: true description: >- The ID of the trip during which this action was generated (if any). readOnly: true x-parser-schema-id: timestamp: type: string format: date-time description: The date/time at which this action was generated.fdfd readOnly: true x-parser-schema-id: type: type: string readOnly: true description: > The type of action: - `VEHICLE_MOV`: Vehicle starts moving (e.g., away from home location/harbor). - `VEHICLE_MOV_ACC`: Vehicle starts moving (as detected by accelerometer). - `VEHICLE_MOV_TOW`: Vehicle starts moving (as indicated via CAN bus). - `SZ_ENTER`: Vehicle enters shore zone (boats). - `ISZ_ENTER`: Vehicle enters inner shore zone (boats). - `OSZ_ENTER`: Vehicle enters outer shore zone (boats). - `SZ_LEAVE`: Vehicle leaves shore zone (boats). - `ISZ_LEAVE`: Vehicle leaves inner shore zone (boats). - `OSZ_LEAVE`: Vehicle leaves outer shore zone (boats). - `SZ_EXSPEED`: Vehicle exceeds speed limit in shore zone (boats). - `ISZ_EXSPEED`: Vehicle exceeds speed limit in inner shore zone (boats). - `OSZ_EXSPEED`:Vehicle exceeds speed limit in outer shore zone (boats). - `HOME_LOCATION_ENTER`: Vehicle enters home location / harbor. - `HOME_LOCATION_LEAVE`: Vehicle leaves home location / harbor. - `STAYPOINT_ENTER`: Vehicle enters a new staypoint (point where it stays for a longer time). - `STAYPOINT_LEAVE`: Vehicle leaves staypoint (point where it stays for a longer time). - `TRIPLEG_START`: Tripleg starts (part of a larger trip between two staypoints). - `TRIPLEG_END`: Tripleg ends. - `TRIP_START`: Trip starts (sequence of multiple triplegs driven in a certain timeframe). - `TRIP_STOP`: Trip stops. This can be a temporary stop, i.e., the trip might be continued. - `TRIP_CONTINUE`: Trip continues. - `TRIP_COMPLETE`: Trip is complete. This action might be generated quite a while after the trip stops due to the time it takes to detect it. - `JOURNEY_START`: Journey starts (a journey is a trip from one home location / harbor to another). - `JOURNEY_STOP`: Journey stops (might be continued). - `JOURNEY_CONTINUE`: Journey continues. - `JOURNEY_COMPLETE`: Jorney is complete. This action might be generated quite a while after the trip stops due to the time it takes to detect it. - `LLV_NC_LT`: Low temperature was detected while no landline is connected. - `LLV_DISC`: Landline (220V) is disconnected. - `LLV_CONN`: Landline (220V) is connected. - `IGNITION_ON`: Ignition is turned on. - `IGNITION_OFF`: Ignition is turned off. - `DIST_REM_CRIT`: The remaining distance is critical. It is recommended to refuel soon. - `TEMP_CRIT`: The (ambient/outdoor) temperature is critical. - `REFUEL`: The vehicle was refueled. - `FUEL_LOW_RET`: The fuel is not 100% when returning to a home location / harbor. - `BAT_LOW`: The battery is low. - `BAT_DISC`: The battery was disconnected. - `USER_BAT_V`: The battery is above / below a user-defined threshold (V). - `USER_BAT_PCT`: The battery is above / below a user-defined threshold (%). - `USER_FUEL_PCT`: The fuel is above / below a user-defined threshold (%). - `USER_TEMP`: The temperature is above / below a user-defined threshold (°C). - `USER_TEMP_1`: Temperature 1 is above / below a user-defined threshold (°C). - `USER_TEMP_2`: Temperature 2 is above / below a user-defined threshold (°C). - `USER_TEMP_3`: Temperature 3 is above / below a user-defined threshold (°C). - `USER_TEMP_4`: Temperature 4 is above / below a user-defined threshold (°C). - `USER_HOME_LOCATION_DIST`: The distance to the home location / harbor is above / below a user-defined threshold (m). - `USER_SHORE_DIST`: The distance to the shore is above / below a user-defined threshold (m). - `USER_GEOFENCE_ENTER`: The vehicle enters a user-defined geofence. - `USER_GEOFENCE_LEAVE`: The vehicle leaves a user-defined geofence. - `USER_STAYPOINT_DIST`: The distance to the last staypoint is above a user-defined threshold (m). - `WATER_IN`: The vehicle was put into the water (boats). - `WATER_OUT`: The vehicle was taken out of the water (boats). - `MAINTENANCE`: A maintenance event reached a critical threshold. - `NEW_TICKET`: A new ticket was created by a user. x-parser-schema-id: message: type: string description: The message corresponding to the action type. readOnly: true x-parser-schema-id: data: type: object description: >- Additional data that is used to describe the action in more detail. readOnly: true x-parser-schema-id: x-parser-schema-id: VehicleAction x-parser-schema-id: title: Vehicle action example: No examples found bindings: [] extensions: - id: x-parser-unique-object-id value: VehicleAction - id: x-parser-message-name value: VehicleAction bindings: [] extensions: - id: x-parser-unique-object-id value: vehicleAction sendOperations: - *ref_0 receiveOperations: [] sendMessages: - *ref_1 receiveMessages: [] extensions: - id: x-parser-unique-object-id value: vehicleAction securitySchemes: [] ````