TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The node interacts with the TeleFlow API to perform various operations on different resources. Specifically, for the Report resource with the Update operation, it updates an existing report by its unique ID. This is useful when you need to modify details of a report already stored in TeleFlow, such as changing report parameters or metadata.

Practical examples include:

  • Updating the name or configuration fields of a report after it has been created.
  • Adjusting report filters or settings dynamically based on workflow conditions.

Properties

Name Meaning
ID The unique identifier of the report to update. Required to specify which report to modify.
Fields A collection of field-value pairs representing the properties to update on the report. Each pair consists of:
- Name: The field name to update.
- Value: The new value for that field.

Note: For the Update operation, the node expects the ID and the fields to update. However, from the bundled code, the actual update payload construction for the Report resource is not explicitly customized, so only the ID is strictly required, and fields can be passed via the "Fields" property if supported.

Output

The output is an array containing one item per input item processed. Each output item has a json property holding the response from the TeleFlow API after updating the report. This JSON typically includes the updated report object with its current state after modification.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "json": {
    "id": "report-id",
    "name": "Updated Report Name",
    "otherField": "updatedValue",
    ...
  }
}

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The base URL for the TeleFlow API must be set in the credentials.
  • The node uses HTTP methods (PUT) to communicate with the API.

Troubleshooting

  • Missing ID error: If the ID property is not provided for the update operation, the node will throw an error stating "ID is required for update operation". Ensure the ID of the report to update is specified.
  • API request failures: Network issues, invalid credentials, or incorrect base URL configurations can cause HTTP errors. Verify API credentials and endpoint URLs.
  • Invalid fields: If fields to update are incorrectly named or have invalid values, the API may reject the request. Double-check field names and values according to TeleFlow API documentation.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.

Links and References

Discussion