Enable events in output streams

Tracking service publishes events to the stream layer in the HERE platform catalog.

Events are published to tc-events layer within the catalog.

Messages sent to the stream are in JSON format and contain following properties:

• type: <string>, Type of the message, identifies the used data format. The only supported value is events.
• version: <string>, Data format version. The only supported value is 1.0.
• events: <array>, Array of event objects. See event schemas for what properties each event object can contain.
• correlationId: <uuid>, ID used for tracing requests. Used for logging and error reporting.

Below is an example of an events message:

{
  "type": "events",
  "version": "1.0",
  "events": [
    {
      "trackingId": "HERE-84fe3e53-5988-4b4a-91fd-47611bb71a7e",
      "timestamp": 1726673335000,
      "ruleId": "6e627562-196d-4a90-838c-fc39372fa98f",
      "eventSource": "temperature",
      "eventType": "IN_RANGE",
      "initialState": true
    }
  ],
  "correlationId": "feb768c9-b0c4-4bbf-bd68-63f99e238b37"
}

To learn how to enable and receive events, see Receive events from output stream.

Event schemas

For specification of events stream messages, see the OpenAPI schema.

The event properties can be seen either from the response schema of /events/v3 API request or from the applicable OpenAPI schemas.