Flow

Operations for creating, reading, updating, and deleting flows. Also covers flow validation, system-provided templates, and device source queries — all resources under the /iot/logic/flow/ path.

flowCreate

post

/iot/logic/flow/create

Create a new data processing flow with nodes and connections. Flows define how data moves from devices through transformation stages to output destinations. Each flow requires at least one Data Source node and one Output Endpoint node. You can create flows with nodes and edges in a single request or add nodes later using the endpoint management API.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Body

Responses

200

Successful creation response

application/json

successbooleanRead-onlyOptional

true if request finished successfully

Example: true

idintegerRead-onlyOptional

ID of the created entity

Example: 1723

default

Error response object

application/json

post/iot/logic/flow/create

POST /v2/iot/logic/flow/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "flow": {
    "title": "Super flow",
    "description": null,
    "enabled": true,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ],
          "push_type": "http",
          "primary_key": "vehicle_id",
          "mappings": [
            {
              "source_id": 123458,
              "primary_key_value": "truck_12"
            },
            {
              "source_id": 123459,
              "primary_key_value": "truck_07"
            }
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

{
  "success": true,
  "id": 1723
}

flowRead

get

/iot/logic/flow/read

Retrieve complete flow configuration including all nodes, edges, and metadata. Returns the flow structure with node positions, connections, and enabled status. Use this endpoint to inspect flow architecture or retrieve configuration for duplication.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Query parameters

flow_idintegerRequired

Flow ID

Example: 12

Responses

200

Successful response to read a flow

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

default

Error response object

application/json

get/iot/logic/flow/read

GET /v2/iot/logic/flow/read?flow_id=12 HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "value": {
    "id": 543,
    "title": "Super flow",
    "description": null,
    "enabled": true,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ],
          "push_type": "http",
          "primary_key": "vehicle_id",
          "mappings": [
            {
              "source_id": 123458,
              "primary_key_value": "truck_12"
            },
            {
              "source_id": 123459,
              "primary_key_value": "truck_07"
            }
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

flowUpdate

post

/iot/logic/flow/update

Update an existing flow's configuration. Requires the complete flow object including all nodes and edges. To modify individual nodes without affecting the entire flow, use the endpoint management API. Changes take effect immediately for enabled flows.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Body

Responses

200

Successful creation response

application/json

successbooleanRead-onlyOptional

true if request finished successfully

Example: true

idintegerRead-onlyOptional

ID of the created entity

Example: 1723

default

Error response object

application/json

post/iot/logic/flow/update

POST /v2/iot/logic/flow/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "flow": {
    "title": "Super flow",
    "description": null,
    "enabled": true,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ],
          "push_type": "http",
          "primary_key": "vehicle_id",
          "mappings": [
            {
              "source_id": 123458,
              "primary_key_value": "truck_12"
            },
            {
              "source_id": 123459,
              "primary_key_value": "truck_07"
            }
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

{
  "success": true,
  "id": 1723
}

flowDelete

post

/iot/logic/flow/delete

Permanently delete a flow and stop its custom data processing pipeline. Devices assigned to this flow keep receiving Navixy's automatic baseline data delivery, which runs independently of custom flow assignment and is unaffected by this change. This action cannot be undone. To temporarily stop processing without deleting the flow, disable it using the update endpoint instead.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Body

flow_idintegerRequired

Flow ID

Example: 12

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

default

Error response object

application/json

post/iot/logic/flow/delete

POST /v2/iot/logic/flow/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "flow_id": 12
}

{
  "success": true
}

flowList

get

/iot/logic/flow/list

List all flows in the user account. Returns summary metadata for each flow (id, title, description, enabled status, last modified timestamp, and device count). Use the read endpoint to retrieve complete flow details including nodes and configuration.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Responses

200

Successful response to read a list of flows

application/json

successbooleanRead-onlyOptional

true if request finished successfully

Example: true

default

Error response object

application/json

get/iot/logic/flow/list

GET /v2/iot/logic/flow/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "list": [
    {
      "id": 1234,
      "title": "Super flow",
      "description": null,
      "enabled": true,
      "modified": "2024-01-15T10:30:00Z",
      "devices_count": 42
    }
  ]
}

flowExport

get

/iot/logic/flow/export

Export a flow as a reusable template without instance-specific metadata. Unlike the read endpoint which retrieves the complete operational state of a flow, export returns only the flow structure (nodes, edges, title, description) suitable for creating duplicate flows or transferring configurations between accounts. The exported template excludes flow ID and enabled status, making it ready for use with the create endpoint.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Query parameters

flow_idintegerRequired

Flow ID to export

Example: 678

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

default

Error response object

application/json

get/iot/logic/flow/export

GET /v2/iot/logic/flow/export?flow_id=678 HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "value": {
    "title": "text",
    "description": null,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ],
          "push_type": "http",
          "primary_key": "vehicle_id",
          "mappings": [
            {
              "source_id": 123458,
              "primary_key_value": "truck_12"
            },
            {
              "source_id": 123459,
              "primary_key_value": "truck_07"
            }
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

sourceMappingList

get

/iot/logic/flow/sources/mapping/list

List all device-to-flow assignments in the user account. Shows which devices are currently assigned to which flows and their corresponding Data Source nodes. Returns device information including title, model, and the flow configuration processing its data. Use this endpoint to audit device assignments, identify unassigned devices, or verify flow coverage across your device fleet. Supports pagination for accounts with large device inventories.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Query parameters

offsetintegerOptionalDefault: 0

limitinteger · min: 1 · max: 100000OptionalDefault: 10000

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

countintegerRead-onlyOptional

Total number of mapping records matching the query

Example: 1

default

Error response object

application/json

get/iot/logic/flow/sources/mapping/list

GET /v2/iot/logic/flow/sources/mapping/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "list": [
    {
      "device_title": "Emulator",
      "model_code": "navixy_ngp",
      "device_id": 123456789,
      "flow_id": 1,
      "flow_title": "Default flow",
      "node_id": 1,
      "node_title": "Source node"
    }
  ],
  "count": 1
}

flowPush

post

/iot/logic/flow/push

Send data from an external system into a connector-configured Data Source node. Navixy reads the field name stored in the node's primary_key setting, looks for a field with that name in the request body, and matches its value against the node's mappings. On a match, Navixy merges the remaining fields into the data stream of the mapped device, as additional attributes rather than a location update. flow_id, node_id, and the primary-key field are excluded from this merge. A pushed field name can match an attribute the device already has, native or from another flow's connector. When it does, the push overwrites that attribute's existing history instead of creating a new one. See Connector configuration for naming guidance. If no field matches, or the request contains no fields besides flow_id, node_id, and the primary key, Navixy discards the push without returning an error. Rate limited to 1 request per second per API key, with a burst size of 1.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Body

flow_idintegerRequired

Flow ID

Example: 42

node_idintegerRequired

ID of the connector-configured Data Source node inside the flow

Example: 1

Other propertiesstring | number | boolean · nullableOptional

Additional fields to merge into the mapped device's data stream. flow_id, node_id, and the primary-key field itself are excluded. Only the remaining fields become attributes. One field must have the name configured in the node's primary_key setting, with a value matching one of the node's mappings. Field names match ^[a-zA-Z0-9_-]+$ and are limited to 64 characters. String values match ^[a-zA-Z0-9_-]*$ and are limited to 100 characters. Nested objects and arrays are ignored. A field name can match an attribute the device already has, native or pushed by another flow's connector. When it does, it overwrites that attribute's existing history instead of creating a new one. Exception: the primary-key value must match the stricter ^[a-zA-Z0-9_]+$ (no hyphens, 1-255 characters) required by mappings[].primary_key_value, or it silently fails to match. See Connector configuration.

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

default

Error response object

application/json

post/iot/logic/flow/push

POST /v2/iot/logic/flow/push HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "flow_id": 42,
  "node_id": 1,
  "vehicle_id": "truck_12",
  "battery_soc": 76,
  "battery_temp": 34.2
}

{
  "success": true
}

flowSchema

get

/iot/logic/flow/schema/read

Return the server-side JSON Schema used to validate flow objects in the Navixy UI form. Clients and LLM agents can fetch this schema to validate a flow structure locally before making a write request. This schema describes the UI form's validation rules, not a guaranteed write-API contract: flowCreate and flowUpdate don't enforce every constraint listed here (for example, a field marked required here may be silently defaulted instead of rejected). The schema is opaque and may change between server versions.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

valueobjectRead-onlyOptional

A JSON Schema document describing the valid structure of a flow. Treat as opaque — the schema may evolve between API versions.

default

Error response object

application/json

get/iot/logic/flow/schema/read

GET /v2/iot/logic/flow/schema/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "value": {}
}

flowTemplateRead

get

/iot/logic/flow/template/read

Retrieve a single system-provided flow template by its ID. A template is a pre-built flow graph (nodes + edges) that can be instantiated as a new flow by passing its structure to flowCreate. Use flowTemplateList to discover available template IDs and their descriptions.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Query parameters

flow_idinteger · min: 1Required

Template ID

Example: 1

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

default

Error response object

application/json

get/iot/logic/flow/template/read

GET /v2/iot/logic/flow/template/read?flow_id=1 HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "value": {
    "id": 1,
    "title": "Basic processing flow",
    "description": "A simple flow for standard telemetry processing.",
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ],
          "push_type": "http",
          "primary_key": "vehicle_id",
          "mappings": [
            {
              "source_id": 123458,
              "primary_key_value": "truck_12"
            },
            {
              "source_id": 123459,
              "primary_key_value": "truck_07"
            }
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

flowTemplateList

get

/iot/logic/flow/template/list

List all system-provided flow templates available to the user. Each item includes the template ID, translated title, and translated description. To get the full node/edge graph for a specific template, use flowTemplateRead. To create a flow from a template, pass its nodes and edges to flowCreate.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

default

Error response object

application/json

get/iot/logic/flow/template/list

GET /v2/iot/logic/flow/template/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "list": [
    {
      "id": 1,
      "title": "Device healthcheck and reboot",
      "description": "Monitors GPS signal quality and schedules a device reboot if signal is poor.",
      "icon": "healthcheck"
    }
  ]
}

flowSourcesList

get

/iot/logic/flow/sources/list

Return the device source IDs currently feeding a specific flow. Pass the flow's ID to get the device IDs explicitly linked to it. Use this to determine which devices a flow processes before modifying source assignments.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Query parameters

flow_idintegerRequired

Flow ID.

Example: 0

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

valueinteger[]Read-onlyOptional

Device source IDs feeding the flow.

Example: [123456,789012]

default

Error response object

application/json

get/iot/logic/flow/sources/list

GET /v2/iot/logic/flow/sources/list?flow_id=0 HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "value": [
    123456,
    789012
  ]
}

flowSourcesAttributeList

post

/iot/logic/flow/sources/attribute/list

Return the telemetry attributes available from the specified devices, for use when authoring expressions in Initiate Attributes or Logic nodes. If source_ids is omitted, returns attributes for all trackers in the account. Set include_only_iot_flow_attributes=true to return only attributes that IoT Logic flows have computed and emitted; omit or set to false to return all attributes including raw device parameters.

Authorizations

AuthorizationstringRequired

Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"

Body

source_idsinteger[] · min: 1 · max: 25000Optional

Device source IDs to query attributes for. If omitted, returns attributes for all trackers in the account.

Example: [123456,789012]

include_only_iot_flow_attributesbooleanOptional

When true, returns only IoT Logic flow-emitted attributes. When false (default), returns all attributes including raw device parameters.

Default: falseExample: false

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

default

Error response object

application/json

post/iot/logic/flow/sources/attribute/list

POST /v2/iot/logic/flow/sources/attribute/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "source_ids": [
    123456,
    789012
  ],
  "include_only_iot_flow_attributes": false
}

{
  "success": true,
  "list": [
    {
      "name": "avg_speed",
      "in_iot_flow": true,
      "received": true
    }
  ]
}

PreviousAPI reference NextNode

Last updated 14 days ago

Was this helpful?