ImmyBot

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 an organization or system managed by ImmyBot. For example, it can be used to display tenant details in a dashboard, verify tenant existence before performing other operations, or integrate tenant data into workflows.

Properties

Output

The output JSON contains the detailed information of the requested tenant as returned by the ImmyBot API. This typically includes tenant-specific fields such as name, ID, status, and any other metadata associated with the tenant. The node does not explicitly mention binary data output, so it is assumed to only return JSON-formatted tenant data.

Dependencies

• Requires an API key credential for authentication with the ImmyBot service.
• The node uses OAuth2-based authentication configured via credentials.
• The base URL for API requests is dynamically constructed using the subdomain from the credentials.
• The node expects the ImmyBot API to be accessible at https://{subdomain}.immy.bot/api/v1.

Troubleshooting

• Common issues:
  • Invalid or missing Tenant ID will cause the API request to fail.
  • Incorrect or expired API credentials will result in authentication errors.
  • Network connectivity problems or incorrect subdomain configuration may prevent access to the API.
• Error messages:
  • Authentication failures usually indicate invalid API keys or OAuth tokens; re-authenticate or update credentials.
  • "Tenant not found" errors suggest the provided Tenant ID does not exist; verify the ID.
  • HTTP errors like 404 or 500 indicate endpoint or server issues; check API availability and parameters.

Links and References

• ImmyBot API Documentation (Assumed official API docs for further details on tenant endpoints)
• n8n OAuth2 Credential Setup Guide (for configuring API authentication)