ImmyBotInstall

Overview

The node is designed to interact with the ImmyBot API, specifically to retrieve information about a tenant by its ID. This operation is useful in scenarios where you need to fetch details of a specific tenant within the ImmyBot system, such as for auditing, reporting, or integration purposes.

For example, if you manage multiple tenants and want to automate the retrieval of tenant details to sync with another system or display tenant info in a dashboard, this node operation would be beneficial.

Properties

Name	Meaning
Tenant ID	The ID number of the tenant to retrieve

Output

The output will contain JSON data representing the tenant's details as returned by the ImmyBot API. This typically includes all relevant fields describing the tenant, such as name, status, configuration, and other metadata defined by the API.

If the node supports binary data output (not indicated here), it would represent any files or attachments related to the tenant, but based on the provided code and properties, the output is purely JSON.

Dependencies

• Requires an API key credential for authentication with the ImmyBot service.
• The node uses the base URL constructed dynamically from the subdomain provided in the credentials.
• The API expects JSON requests and returns JSON responses.
• Proper configuration of the OAuth2 API credential with the correct subdomain and access token is necessary.

Troubleshooting

• Common issues:
  • Invalid or missing Tenant ID: Ensure the Tenant ID is provided and is a valid number.
  • Authentication errors: Verify that the API key credential is correctly configured and has the necessary permissions.
  • Network or connectivity problems: Check internet connection and that the subdomain is correct.
• Error messages:
  • Unauthorized or 401 errors indicate invalid or expired credentials.
  • 404 Not Found may mean the Tenant ID does not exist.
  • 400 Bad Request could indicate malformed input parameters.

Resolving these usually involves verifying input values, refreshing credentials, and confirming API endpoint accessibility.

Links and References

• ImmyBot API Documentation (Assumed official API docs)
• n8n OAuth2 Credential Setup Guide (for configuring API authentication)