TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The node interacts with the TeleFlow API to perform various operations on different resources, including "Flow". Specifically, for the "Flow" resource and the "Get Many" operation, it retrieves multiple flow records from the TeleFlow system. This is useful when you want to fetch a list of flows, optionally filtered by specific fields.

Common scenarios include:

  • Retrieving all flows or a subset based on certain criteria.
  • Integrating flow data into automation workflows for monitoring or reporting.
  • Synchronizing flow information with other systems.

Example: You might use this node to get all flows that match certain field values (e.g., flows with a specific name or status) to process them further in your workflow.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the flows returned by the API request. You can specify multiple fields to narrow down the query results. For example, filtering flows by "name" or other attributes supported by the API.

Output

The output is an array of JSON objects representing the flows retrieved from the TeleFlow API. Each object corresponds to a flow record and contains its properties as returned by the API.

  • The json field holds the flow data.
  • No binary data output is indicated.

Example output structure (simplified):

[
  {
    "id": "flow1",
    "name": "Example Flow",
    "status": "active",
    ...
  },
  {
    "id": "flow2",
    "name": "Another Flow",
    "status": "inactive",
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the API must be configured in the credentials.
  • The node uses HTTP requests to communicate with the TeleFlow REST API.

Troubleshooting

  • Missing or invalid API credentials: Ensure the API key and base URL are correctly set in the node's credentials.
  • Invalid field names or values in filters: Using unsupported or misspelled field names in the "Fields" property may result in empty responses or errors.
  • API errors: If the API returns an error (e.g., unauthorized, not found), the node will throw an error unless "Continue On Fail" is enabled.
  • ID required errors: Although not applicable for "Get Many", other operations require an ID parameter; ensure IDs are provided where necessary.

Links and References

Discussion