ImmyBot icon

ImmyBot

ImmyBot Node
Join our community

Actions24

Overview

The node interacts with the ImmyBot API to retrieve multiple provider links. Specifically, the "Get Many Provider Links" operation fetches a list of provider links, optionally including associated clients and unlinked clients. This is useful in scenarios where you need to manage or audit provider connections and their client associations within ImmyBot.

Practical examples:

  • Fetching all provider links along with their linked clients for reporting.
  • Retrieving provider links including clients that are not yet linked to any provider.
  • Ensuring that the agent installer version is set before processing provider links, throwing an error if it is missing.

Properties

Name Meaning
Include Clients Whether to include clients linked to each provider link in the response (true/false).
Include Unlinked Clients Whether to include clients that are not linked to any provider link (true/false).
Throw If Agent Installer Version Not Set Whether to throw an error if the agent installer version is not set (true/false).

Output

The output JSON contains an array of provider links, each potentially enriched with client information depending on the input properties. The structure typically includes details about each provider link and, if requested, arrays of linked clients and unlinked clients.

If the node supports binary data output, it would represent related files or attachments; however, based on the provided code and context, this node primarily outputs JSON data representing provider links and clients.

Dependencies

  • Requires an API key credential for authenticating with the ImmyBot API.
  • Needs the subdomain configuration as part of the credentials to construct the base URL for API requests.
  • The node depends on the ImmyBot API v1 endpoint: https://{subdomain}.immy.bot/api/v1.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key and subdomain are correctly configured in the node credentials.
  • Agent installer version not set error: If the property "Throw If Agent Installer Version Not Set" is enabled and the agent installer version is missing, the node will throw an error. To resolve, either set the agent installer version in ImmyBot or disable this option.
  • Empty or incomplete responses: Verify that the "Include Clients" and "Include Unlinked Clients" options are set according to your needs to get the expected data.
  • Network or connectivity issues: Confirm that the n8n instance can reach the ImmyBot API endpoint and that no firewall or proxy is blocking the requests.

Links and References

Discussion