TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources. Specifically, for the Account Audit resource with the Get Many operation, it retrieves multiple account audit records from the TeleFlow system. This is useful when you want to fetch a list of audit entries related to accounts, possibly filtered by specific fields.

Common scenarios include:

  • Auditing changes or activities related to accounts in your TeleFlow environment.
  • Generating reports or logs based on account audit data.
  • Integrating account audit information into workflows for compliance or monitoring purposes.

For example, you might use this node to get all account audit entries where a certain field matches a value, such as audits performed by a specific user or within a date range.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the request. You can add multiple pairs to specify which audit records to retrieve. Each pair consists of:
- Name: The field name to filter by (string).
- Value: The corresponding value to match (string).

Output

The output is an array of JSON objects representing the retrieved account audit records. Each object corresponds to one audit entry and contains the fields returned by the TeleFlow API for account audits.

No binary data is output by this node.

Example output structure (simplified):

[
  {
    "id": "123",
    "accountId": "456",
    "action": "update",
    "changedBy": "user@example.com",
    "timestamp": "2024-01-01T12:00:00Z",
    ...
  },
  {
    "id": "124",
    "accountId": "789",
    "action": "create",
    "changedBy": "admin@example.com",
    "timestamp": "2024-01-02T08:30:00Z",
    ...
  }
]

The exact fields depend on the TeleFlow API response.

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 sends HTTP GET requests to the /accountAudits endpoint with optional query parameters based on the specified fields.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key and base URL are correctly set in the node credentials.
  • Invalid field names or values: If filtering fields do not match the API's expected parameters, the request may return no results or an error.
  • Network issues or API downtime: HTTP request failures may occur; check network connectivity and TeleFlow service status.
  • Error message "ID is required for get/update/delete": Not applicable for Get Many operation but relevant for other operations requiring an ID.

If the node throws errors related to HTTP requests, verify the correctness of the base URL, authentication, and query parameters.

Links and References

Discussion