TeleFlow icon

TeleFlow

Interact with TeleFlow API

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.

Practical examples include:

  • Fetching an email template before sending an email campaign.
  • Retrieving template details to display or edit in a custom UI.
  • Automating workflows that require conditional logic based on template properties.

Properties

Name Meaning
ID The unique identifier of the email template to retrieve. This is required for the get operation.
Fields Optional key-value pairs specifying additional fields to include in the request query string. Each pair consists of a field name and its corresponding value, allowing more specific queries or filtering.

Output

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

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 key credential for authenticating with the TeleFlow API.
  • The node expects the base URL of the TeleFlow API to be configured in the credentials.
  • Network access to the TeleFlow API endpoint is necessary.

Troubleshooting

  • Missing ID error: If the ID property is not provided for the get operation, the node will throw an error stating that the ID is required. Ensure you provide a valid template ID.
  • API request failures: Errors from the TeleFlow API (e.g., 404 Not Found if the template does not exist) will be surfaced. Verify the ID is correct and that your API credentials have sufficient permissions.
  • Invalid fields: Providing incorrect or unsupported field names in the Fields property may result in unexpected responses or errors. Use only valid field names supported by the TeleFlow API.
  • Network issues: Connectivity problems or incorrect base URL configuration can cause request failures. Check network settings and credential configurations.

Links and References

Discussion