TeleFlow icon

TeleFlow

Interact with TeleFlow API

Actions82

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including Email Templates. Specifically, for the Email Template - Get operation, it retrieves a single email template by its unique ID. This is useful when you need to fetch detailed information about a specific email template stored in TeleFlow, such as its content, metadata, or configuration.

Common scenarios include:

  • Fetching an email template before sending an email to ensure the correct template is used.
  • Retrieving template details for auditing or display purposes in workflows.
  • Integrating TeleFlow email templates into other systems or processes by extracting their data.

Properties

Name Meaning
ID The unique identifier of the email template to retrieve. This is required.
Fields Optional key-value pairs specifying additional fields to include in the request query string. You can add multiple fields, each with a name and value, to filter or customize the returned data.

Output

The output is a JSON object representing the retrieved email template's data as returned by the TeleFlow API. It includes all the properties of the email template resource, such as its ID, name, content, and any other metadata provided by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "template-id",
  "name": "Welcome Email",
  "subject": "Welcome to Our Service",
  "body": "<html>...</html>",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-02-01T12:00:00Z"
}

Dependencies

  • Requires an API authentication token configured in the node credentials to access the TeleFlow API.
  • The base URL for the TeleFlow API must be set in the node credentials.
  • The node uses HTTP requests to communicate with the TeleFlow REST API endpoints.

Troubleshooting

  • Missing ID error: If the ID property is not provided, the node will throw an error stating that the ID is required for the get operation. Ensure you provide a valid template ID.
  • Authentication errors: If the API key or base URL is incorrect or missing, the node will fail to connect. Verify your credentials and API endpoint configuration.
  • Invalid field names: When using the optional Fields property, providing incorrect field names may result in unexpected responses or errors from the API.
  • API rate limits or downtime: If the TeleFlow API is unavailable or rate-limited, requests may fail. Check the API status and retry later.

Links and References

Discussion