The CloudRadial AutomationAI ImmyBot extension lets a workflow or agent work with your ImmyBot instance: inventory managed computers, review maintenance sessions and deployments, browse the software and maintenance-task catalog, run maintenance or remediation across computers and tenants, and generate an agent installer to onboard a device. This article covers what the extension can do, the Microsoft Entra ID app registration and secrets it needs, which tools require approval, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
- What the Extension Covers
- Registering the App in Microsoft Entra ID
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Running Maintenance and Audits
- Skills
- Tips for Working With ImmyBot
What the Extension Covers
The extension calls the ImmyBot REST API on your own ImmyBot instance and provides 15 tools across these areas:
| Area | Tools | What you can automate |
| Computers | 3 | List managed computers, optionally for one tenant, read one computer, and check whether a computer is online |
| Maintenance sessions | 4 | Start a maintenance or remediation session, list and search sessions, read one session with its actions, stages, and logs, and get session counts by status |
| Deployments and catalog | 4 | List deployments, which ImmyBot calls target assignments, and browse the global and tenant-local software catalog and the global maintenance tasks |
| Tenants, providers, and people | 3 | List ImmyBot tenants (your client organizations), connected providers and integrations, and people across linked tenants |
| Onboarding | 1 | Generate an agent installer download link that onboards a new device to a tenant |
Install it from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
Registering the App in Microsoft Entra ID
ImmyBot's API accepts tokens issued by Microsoft Entra ID. The runner signs in with an Entra app registration's client ID and client secret, gets a token for your ImmyBot instance, and sends it on every call. To set this up:
- In Microsoft Entra ID, create an app registration and copy its Application (client) ID
- On the registration's Certificates & Secrets page, create a client secret and copy its value
- In ImmyBot, under People, link the registration's Enterprise App Object ID as the AD External ID. This grants the app access to the ImmyBot API.
- Note your Entra directory (tenant) ID
ImmyBot's "Build Your Own Integration" guide in its documentation describes the same setup.
Providing the Credentials to Your Runner
Store four secrets in your runner's Key Vault with these exact names:
| Secret | Value |
ImmyBot-ApiUrl |
Your ImmyBot instance's base URL, https://{subdomain}.immy.bot, where {subdomain} is your instance name |
ImmyBot-TenantID |
Your Microsoft Entra directory (tenant) ID, a GUID |
ImmyBot-ClientID |
The Application (client) ID of the app registration, a GUID |
ImmyBot-ClientSecret |
The client secret value from the app registration |
For how to add secrets, see Accessing and updating your runner's Key Vault. The agent reads the credentials from the runner and never asks you for them.
Reads and Approval-Gated Changes
Of the 15 tools, 13 only read data and run without interruption. The other two act on your ImmyBot instance and pause the run for approval. The request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
| Tool behavior | Tools |
| Approval-gated | Start a maintenance or remediation session; generate an agent installer |
| Read-only | List and read computers and their online status; list, search, and read maintenance sessions and session counts; list deployments, software, and maintenance tasks; list tenants, providers, and people |
Running Maintenance and Audits
A maintenance session targets one or more computers, one or more tenants, or both. The agent resolves the computer or tenant ids first, then asks for approval to start the session. The request can set:
- Detection only, an Audit pass that detects what needs to change and applies nothing
- Full maintenance or resolution only
- A reboot preference: force, if necessary, or suppress
- Whether to send a follow-up email, and how to handle computers that are offline
Without detection only, the session applies remediation. Ask for an Audit pass first when you want to see what ImmyBot would change. After a session starts, the agent can read it back with its actions, stages, and logs to report the outcome.
Skills
The extension ships four skills that guide an agent through common ImmyBot tasks:
| Skill | Use it to |
| Inventory ImmyBot Computers | List or look up managed computers, check whether a device is online, or limit an inventory to one tenant. Read-only. |
| Run Maintenance / Remediation | Remediate, audit, or run maintenance on computers or tenants, and review the outcome of a session. Starting a session is approval-gated. |
| Review Deployments & Catalog | Review what software or maintenance tasks ImmyBot deploys, and browse the global and local software and maintenance-task catalog. Read-only. |
| List Tenants & Providers | List tenants and connected providers, resolve a tenant by name, or generate an agent installer to onboard a device. Generating an installer is approval-gated. |
Tips for Working With ImmyBot
- Refer to tenants and computers by name. The agent looks up their ids before it starts a session or generates an installer.
- To generate an installer, the agent needs the provider link and the tenant, and can also set a person as the device's primary user. It resolves each from the providers, tenants, and people lists.
- The installer tool returns a direct download link for the installer
- You can search maintenance sessions by computer, tenant, session type, or status, for example to find the sessions still running
- If a call returns HTTP 404, compare it with your instance's own API reference at
https://{subdomain}.immy.bot/swagger, the only place ImmyBot publishes its API
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.