For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quick start: create your first flow

Create your first IoT Logic flow with a single API request. Builds a four-node flow that detects a speed violation, sends a device command, and forwards data to Navixy.

This guide creates a working IoT Logic flow with one API request. The flow collects telemetry from selected devices, checks each message for a speed above 90 km/h, sends a command to the device when the speed is exceeded, and forwards every message to the Navixy platform. Use it to confirm that your credentials work and to see how nodes and edges fit together before you build a flow of your own.

Prerequisites

Before you send the request, you need three things:

  • An API key or a session hash. Pass it in the Authorization header as NVX your_hash_or_api_key. To obtain one, see Authentication.

  • The source IDs of the devices that will feed the flow. Use each device's source.id, not the tracker object ID. See Source ID vs tracker object ID.

  • Your regional base URL, either https://api.eu.navixy.com or https://api.us.navixy.com.

Create the flow

Create a flow with all nodes and connections in a single request:

Response (example):

Parameters explained

  • Flow entity: The main container defining a complete data processing pipeline

    • title: Names your flow for easier identification

    • enabled: When true, flow begins processing data immediately after creation

  • Nodes: Functional components that each handle a specific step in data processing. See Nodes for full node schemas and options.

    • Node 1 (data_source): Entry point for device telemetry.

    • Node 2 (logic): Branching decision based on a boolean expression.

      • condition: "speed > 90" routes each message to THEN or ELSE.

    • Node 3 (action): Executes device commands on the THEN branch.

      • actions[].type: "send_gprs_command" sends the command to the triggering device (by default).

    • Node 4 (output_endpoint): Terminates the flow and defines the destination.

      • output_endpoint_type: "output_default" sends messages to Navixy.

  • Edges: Define connections between nodes (the data path).

    • { "from": 1, "to": 2 }: data source → logic.

    • { "from": 2, "to": 3, "type": "then_edge" }: violation → action.

    • { "from": 2, "to": 4, "type": "then_edge" }: violation → output.

    • { "from": 2, "to": 4, "type": "else_edge" }: no violation (or condition can’t be evaluated) → output.

    • Both Logic branches resolve to an output endpoint (required for a valid flow).

What this flow does

Next steps

Last updated

Was this helpful?