TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including Flow Templates. Specifically, the Delete operation for the Flow Template resource allows users to remove a flow template by its unique identifier. This is useful in scenarios where outdated or unused flow templates need to be cleaned up to maintain an organized system.

Practical examples:

  • Automatically deleting deprecated flow templates as part of a workflow cleanup process.
  • Removing test or temporary flow templates after validation.
  • Managing lifecycle of flow templates programmatically without manual intervention.

Properties

Name Meaning
ID The unique identifier of the flow template to delete. Required for the delete operation.
Fields Optional field-value pairs to include in the request for more specific queries (not used in delete but available for other operations).

Output

The output JSON contains the response from the TeleFlow API after attempting to delete the specified flow template. Typically, this will include confirmation of deletion or relevant status information returned by the API.

Example output structure:

{
  "status": "success",
  "message": "Flow template deleted successfully"
}

If an error occurs and the node is set to continue on failure, the output will contain an error field describing the issue.

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 requests to communicate with the TeleFlow REST endpoints.

Troubleshooting

  • Missing ID Error: If the ID property is not provided, the node throws an error stating that the ID is required for the delete operation. Ensure the ID is correctly set.
  • API Authentication Errors: If the API key or base URL is incorrect or missing, authentication will fail. Verify credentials configuration.
  • Resource Not Found: Deleting a non-existent flow template may return an error from the API. Confirm the ID is valid.
  • Network Issues: Connectivity problems can cause request failures. Check network access to the TeleFlow API endpoint.
  • Continue On Fail Behavior: If enabled, errors will be captured in the output JSON instead of stopping execution, allowing workflows to handle failures gracefully.

Links and References

Discussion