ImmyBotInstall

Overview

The node provides integration with the ImmyBot API, specifically allowing management of tenants within the system. The "Tenant - Create" operation enables users to create a new tenant entity by specifying details such as its name, slug, parent tenant, whether it is a Managed Service Provider (MSP), and the owner tenant ID.

This node is beneficial in scenarios where organizations need to programmatically manage hierarchical tenant structures, for example:

• Creating new client accounts or organizational units in a multi-tenant SaaS platform.
• Automating onboarding processes by provisioning tenants with specific ownership and hierarchy.
• Managing MSP relationships by marking tenants accordingly.

Practical example: An IT service provider could use this node to automatically create tenant records for each new customer, setting the appropriate parent tenant and ownership information to reflect their organizational structure.

Properties

Name	Meaning
Name	The name of the tenant to be created.
Slug	A URL-friendly identifier (slug) for the tenant.
Parent Tenant ID	Optional numeric ID of the parent tenant, establishing a hierarchy.
Is MSP	Boolean flag indicating if the tenant is a Managed Service Provider.
Owner Tenant ID	Numeric ID of the owner tenant; required to specify who owns this tenant.

Output

The node outputs JSON data representing the newly created tenant object as returned by the ImmyBot API. This typically includes fields such as the tenant's unique ID, name, slug, parent tenant reference, MSP status, and ownership details.

No binary data output is involved in this operation.

Dependencies

• Requires an API authentication token configured via OAuth2 credentials for the ImmyBot service.
• The node expects the user to provide a valid subdomain credential to construct the base URL for API requests.
• Network access to the ImmyBot API endpoint is necessary.

Troubleshooting

• Authentication errors: If the node fails due to invalid or missing credentials, verify that the OAuth2 token is correctly set up and has not expired.
• Validation errors: Missing required properties like "Name" or "Owner Tenant ID" will cause the API to reject the request. Ensure all mandatory fields are provided.
• Parent Tenant ID issues: Providing an invalid or non-existent parent tenant ID may result in errors. Confirm the parent tenant exists before referencing it.
• API connectivity problems: Network issues or incorrect subdomain configuration can prevent successful API calls. Check network settings and credential subdomain value.

Links and References

• ImmyBot API Documentation (hypothetical link for reference)
• OAuth2 Authentication setup guides in n8n documentation for configuring API credentials