ImmyBot icon

ImmyBot

ImmyBot Node

Actions24

Overview

This node integrates with the ImmyBot API to manage tenants. Specifically, the "Delete" operation under the "Tenant" resource allows users to delete one or more tenants by specifying their IDs. This is useful for automating tenant lifecycle management, such as cleaning up unused or expired tenants in bulk.

A practical example would be a workflow that periodically removes tenants that are no longer active by passing their IDs as a JSON array to this node.

Properties

Name Meaning
IDs A JSON array of tenant IDs to delete. For example: ["297", "298"]. This property is required and expects a string representing a JSON array of IDs.

Output

The node outputs data on its main output. The json field will typically contain the response from the ImmyBot API after attempting to delete the specified tenants. This may include confirmation of deletion or error details if any IDs could not be deleted.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authentication with the ImmyBot API.
  • The node uses the base URL constructed dynamically from the credential's subdomain (e.g., https://<subdomain>.immy.bot/api/v1).
  • Proper configuration of the OAuth2 API credentials is necessary for successful requests.

Troubleshooting

  • Invalid JSON Array: If the "IDs" property is not a valid JSON array string, the node will likely fail. Ensure the input is correctly formatted, e.g., ["297", "298"].
  • Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Verify that the OAuth2 credentials are set up correctly.
  • Non-existent Tenant IDs: Attempting to delete tenant IDs that do not exist may result in errors or partial success responses. Confirm the IDs before deletion.
  • API Connectivity Issues: Network problems or incorrect subdomain configuration can prevent the node from reaching the API endpoint.

Links and References

Discussion