TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage tenants and other resources. Specifically, for the Tenant - Create operation, it allows users to create a new tenant by specifying its name. This is useful in scenarios where you want to programmatically add tenants to your TeleFlow system as part of an automated workflow, such as onboarding new clients or setting up isolated environments.

Practical examples include:

  • Automatically creating a tenant when a new customer signs up.
  • Setting up multiple tenants in bulk from a data source.
  • Integrating tenant creation into a larger provisioning or deployment pipeline.

Properties

Name Meaning
Name The descriptive name of the tenant to be created.
Fields Additional field-value pairs to include in requests (used in other operations, not create).

Note: For the Create Tenant operation, only the Name property is required and used.

Output

The output is a JSON object representing the newly created tenant as returned by the TeleFlow API. It typically includes details such as the tenant's unique identifier, name, and any other metadata provided by the API response.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

No binary data is produced by this node.

Dependencies

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

Troubleshooting

  • Missing Required Property: If the "Name" property is empty or missing, the node will fail because the API requires a tenant name.
  • API Authentication Errors: Ensure that the API key credential is correctly set up and has permissions to create tenants.
  • Network Issues: Connectivity problems to the TeleFlow API endpoint can cause request failures.
  • Unexpected API Response: If the API changes or returns errors, check the error message logged by the node for details.

Common error message example:

  • "ID is required for get/update/delete operations" — This does not apply to create but indicates that for other operations, the ID parameter must be provided.
  • General HTTP errors will be surfaced with their messages; verify credentials and input parameters accordingly.

Links and References

Discussion