Event Logging
API for sending user-generated event log entries associated with a robot or fleet.
Add Event Log
- Cloud
- Local
Submits a log message tied to a specific robot and fleet.
Endpoint
POST /events/log?robotId={robotId}&fleetId={fleetId}&message={message}
Request Headers
{
"authorization": "bearer <access_token>"
}
Query Parameters
- robotId (string): The unique identifier of the robot.
- fleetId (string, optional): The unique identifier of the fleet.
- message (string): The log message to record.
Response
Returns 200 OK on success with an empty body.
Example
POST /events/log?robotId=11111111-2122-1122-2233-555555319861&message=Maintenance+check+completed
Writes a user event message to the selected agent's local log. robotId and fleetId are included
as structured log context when supplied; the local endpoint does not persist a separate cloud event
record.
Endpoint
POST /events/log?robotId={robotId}&fleetId={fleetId}&message={message}
Request Headers
{
"authorization": "bearer <local-api-gateway-token>"
}
Query Parameters
- robotId (string, optional): Robot identifier to include in the log context.
- fleetId (string, optional): Fleet identifier to include in the log context.
- message (string, required): The event message.
Response
Returns 200 OK with an empty body.
Example
POST /events/log?robotId=robot-1&fleetId=local-fleet&message=Maintenance+check+completed
Common Errors
400:messageis missing or empty.401: bearer token is missing or invalid.403: Local API Gateway is disabled.