ImmyBot

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 for scenarios where you need to manage or audit provider connections and their client associations within ImmyBot.

Practical examples include:

• Retrieving all provider links to display in a dashboard.
• Including linked clients to understand which clients are connected to each provider link.
• Including unlinked clients to identify clients not currently associated with any provider link.
• Enforcing that an agent installer version is set by throwing an error if it is missing, ensuring data consistency.

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 in the response (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 the list of provider links retrieved from the ImmyBot API. Depending on the input properties:

• It may include nested client information for each provider link if "Include Clients" is true.
• It may also include clients that are not linked to any provider link if "Include Unlinked Clients" is true.
• If the "Throw If Agent Installer Version Not Set" property is enabled and the agent installer version is missing, the node will throw an error instead of returning data.

No binary data output is indicated.

Dependencies

• Requires an API key credential for authenticating with the ImmyBot API via OAuth2.
• The node uses the subdomain from credentials to construct the base URL for API requests.
• Proper configuration of the ImmyBot OAuth2 API credential is necessary.

Troubleshooting

• Missing or invalid API credentials: Ensure the OAuth2 API credential is correctly configured with valid authentication details.
• Agent installer version not set error: If this error occurs, verify that the agent installer version is properly configured in your ImmyBot environment or disable the "Throw If Agent Installer Version Not Set" option if appropriate.
• Empty or incomplete data: Check the boolean flags for including clients and unlinked clients to ensure you receive the expected data scope.
• Network or API errors: Confirm network connectivity and that the subdomain in credentials is correct.

Links and References

• ImmyBot API Documentation (assumed based on baseURL pattern)
• n8n OAuth2 Credential Setup Guide (for configuring API authentication)