TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including tenants. Specifically, the Tenant - Get operation retrieves detailed information about a tenant by its unique identifier. This is useful in scenarios where you need to fetch configuration or metadata about a specific tenant within the TeleFlow system.

Practical examples include:

  • Retrieving tenant details for auditing or reporting.
  • Fetching tenant information before performing updates or deletions.
  • Integrating tenant data into workflows that require tenant-specific context.

Properties

Name Meaning
ID The unique identifier of the tenant resource to retrieve. This is required.
Fields Optional field-value pairs to specify additional query parameters for filtering or detail.

The Fields property allows adding multiple custom fields as key-value pairs to refine the GET request. For example, you might specify certain attributes to include or filter by.

Output

The output is a JSON object representing the tenant resource retrieved from the TeleFlow API. It contains all the tenant's properties as returned by the API, such as name, ID, and any other tenant-specific metadata.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "tenant-id",
  "name": "Tenant Name",
  "otherProperty": "value",
  ...
}

Dependencies

  • Requires an API authentication credential configured in n8n to access the TeleFlow API.
  • The base URL for the TeleFlow API must be set in the credentials.
  • The node uses HTTP requests with JSON content type and expects JSON responses.

Troubleshooting

  • Missing ID error: If the ID property is not provided for the get operation, the node will throw an error stating "ID is required for get operation". Ensure the ID is correctly set.
  • API connectivity issues: Errors related to network or authentication failures may occur if the API key or base URL is incorrect or missing.
  • Invalid fields: Providing unsupported or incorrect field names in the Fields property may result in unexpected API responses or errors.
  • To handle errors gracefully, enable the "Continue On Fail" option in the node settings to allow workflow execution to proceed despite individual item errors.

Links and References

Discussion