ImmyBot icon

ImmyBot

ImmyBot Node

Actions24

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, hierarchical relationships, and ownership. This is useful in scenarios where organizations need to programmatically manage multi-tenant environments, for example, when onboarding new clients or setting up isolated environments for different departments or customers.

Practical examples include:

  • Automating tenant creation during customer onboarding workflows.
  • Structuring tenants hierarchically by assigning parent tenants.
  • Defining whether a tenant acts as a Managed Service Provider (MSP).
  • Assigning ownership to ensure proper access control and billing.

Properties

Name Meaning
Name The name of the tenant to be created.
Slug A URL-friendly identifier for the tenant, often used in URLs or API references.
Parent Tenant ID Optional numeric ID of an existing tenant to set as the parent, establishing hierarchy.
Is MSP Boolean flag indicating if the tenant is a Managed Service Provider.
Owner Tenant ID Numeric ID of the tenant that owns this new tenant; required for creation.

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 information, MSP status, owner tenant ID, and possibly timestamps or metadata related to creation.

If the node supports binary data output, it would generally relate to file attachments or exports associated with tenants, but based on the provided code and properties, the output is purely JSON structured data about the tenant.

Dependencies

  • Requires an API key credential for authenticating with the ImmyBot API.
  • The base URL for API requests is dynamically constructed using a subdomain from credentials.
  • The node expects the ImmyBot API to be accessible at https://{subdomain}.immy.bot/api/v1.
  • Proper configuration of the OAuth2 API credential is necessary for successful authentication.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Validation errors: Missing required fields like "Name" or "Owner Tenant ID" will cause the API to reject the request. Double-check all required inputs.
  • Parent Tenant ID issues: If specifying a parent tenant, verify that the ID exists and is valid; otherwise, the API may return an error.
  • Network connectivity: Confirm that the subdomain and network allow access to the ImmyBot API endpoint.
  • Slug conflicts: Using a slug that already exists might cause conflicts; choose unique slugs.

Links and References

Discussion