> For the complete documentation index, see [llms.txt](https://docs.rewst.help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rewst.help/documentation/integrations/integration-guides/immybot-integration-setup.md). # ImmyBot integration This document outlines the requirements and setup for the ImmyBot integration. {% hint style="info" %} If you’re new to integrations in Rewst, read through our introductory integration documentation [here](https://docs.rewst.help/documentation/integrations). {% endhint %} {% hint style="warning" %} ImmyBot does not suppot multi-instance integration. For more on this topic, see our documentation [here](/documentation/integrations/multi-instance-integration.md), {% endhint %} ## What does the ImmyBot integration do? Our ImmyBot integration enables the automation of remote machine management and monitoring. Use the ImmyBot API within Rewst workflows to gather detailed information and perform various operations on remotely managed machines, people, software, and scripts. {% hint style="info" %} By default, ImmyBot's generated credentials expire two years after creation. If your integration suddenly fails and has been working for some time, try reauthorizing the integration with new credentials. {% endhint %} ## Set up the ImmyBot integration ### What is automatic provisioning? *Automatic Provisioning* for ImmyBot is an optional but recommended setting enabled during configuration setup. It allows for automatic authorization with your partner accounts into the Rewst platform to make integration setup easier. When enabled, Rewst will create an App Registration in your Azure tenant to utilize for authentication with your ImmyBot instance. ### Set up steps in Rewst 1. Navigate to **Marketplace > Integrations** in the left side menu of your Rewst platform. 2. Search for `ImmyBot` in the integrations page.\ \ ![](https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2Ft51ZrkZK5cXj4198RAe9%2FScreenshot%202025-05-05%20at%203.42.15%E2%80%AFPM.png?alt=media\&token=1e238486-d6ab-4569-b81b-c2a672ffb78f) 3. Click on the integration tile to launch the configuration setup page. 4. Enter your ImmyBot **Hostname**: for example, `rewst-qa.immy.bot`. 5. Click **Next**. 6. Choose to toggle **Automatic Provisioning** on or off. 1. When enabled, Rewst will create an App Registration in your Azure tenant to utilize for authentication with your ImmyBot instance. 2. Note that if you choose to create this yourself or use the ImmyBot provisioned App Registration instead, then Rewst will not be able to provide all of the relevant values during setup steps 3. Complete the OAuth popup. The authorizing account must have sufficient Entra privileges to create app registrations and service principals in the tenant. On success, the information will automatically populate into the configuration fields in Rewst. 7. Enter the information copied from ImmyBot into the relevant fields if you choose not to use Automatic Provisioning: * **Microsoft Tenant ID** - The ID of the Microsoft 365 Tenant associated with your ImmyBot instance * **Application ID -** The Application ID of the Azure Enterprise App that Rewst will use to authenticate with ImmyBot * **Client Secret -** The Client Secret of the Azure app registration Rewst will use to authenticate with ImmyBot 8. Click **Next**. 9. Click the link that appears on the integration configuration screen to navigate to ImmyBot's Persons Settings. Create a new Person for Rewst to use. Use your primary Tenant, and set the Azure Object ID field value. The Person's **email** field must not match the email address of an existing user in your Azure AD tenant, otherwise future Azure syncs from the ImmyBot side will overwrite this value and result in 403 Forbidden Errors when running ImmyBot actions. 1. You must sign in to the Microsoft dialog with an account that's allowed to create app registrations in the company's Microsoft tenant— usually an admin. If the account doesn't have that permission, Microsoft refuses access and Rewst will show error. 10. Click **Continue** to create your user and assign the admin Role. 11. Click **Test configuration**. If the integration is working properly, a green confirmation message will appear at the top of your screen. 12. Click **Finish**. ### Set up steps in Microsoft These steps are only needed if you choose not to use Automatic Provisioning. To replicate what that process creates, register an app in the Entra tenant with: * **Supported account types:** Accounts in any organizational directory - multitenant * **API permissions:** Microsoft Graph → Delegated → `User.Read` * **Client secret:** generate one under **Certificates & secrets** and record the value immediately * **Service principal:** created automatically when the app is registered in the tenant. No separate step is needed. To complete these steps, your permissions in ImmyBot must be set to System Administrator. If your account was previously designated as Admin, ImmyBot automatically granted you the permission level of System Administrator (Legacy) in their recent permissioning change update. This is sufficient to set up the integration with Rewst. {% hint style="success" %} Got an idea for a new Integration? Rewst is constantly adding new integrations to our integrations page. Submit your idea or upvote existing ideas here in our [Canny feedback collector](https://rewst.canny.io/integrations). {% endhint %} ## Triggers for ImmyBot integration | Trigger type name | Type | Description | | --------------------- | ------- | ------------------------------------------------------------------- | | New Computer Detected | Polling | Triggers when new computer is found that has not yet been onboarded | ## Actions and endpoints {% hint style="info" %} For more on how actions work in Rewst, check out our [introductory actions documentation here](https://docs.rewst.help/documentation/workflows/actions-in-rewst). {% endhint %} | Category | Action | Description | | ----------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------- | | **Assignments** | List Target Assignments | Get a list of target assignments (deployments) available | | **Assignments** | List Recommended Assignments | Get a list of pre-configured target assignments (deployments) that can be approved or dismissed | | **Assignments** | Create Target Assignment | Create a new target assignment (deployment) for a software or task | | **Assignments** | Update Target Assignment | Updates an existing target assignment (deployment) for a software or task | | **Assignments** | Delete Target Assignment | Delete an existing target assignment (deployment) for a software or task | | **Auth** | Check Auth | Description coming soon... | | **Computers** | List Computers | Get a list of computers | | **Computers** | Get Computer | Get a computer by ID | | **Computers** | Assign Person to Computer | Updates an existing target device with a primary user | | **Generic Request** | ImmyBot API Request | Generic action for making authenticated requests against the ImmyBot API | | **Maintenance Actions** | List Actions For Computer | Get a list of available maintenance actions for a given computer | | **People** | List People | Get a list of People | | **Scripts** | List Scripts | Get a list of scripts available in ImmyBot | | **Scripts** | Get Script | Get a script by ID | | **Scripts** | Get Script References | Gets any software, software versions or tasks referencing a given script | | **Scripts** | Create Script | Creates a new script in ImmyBot | | **Scripts** | Run Script | Runs a script defined in ImmyBot against a target computer | | **Scripts** | Run Ad Hoc Script | Runs an on demand script against a computer in ImmyBot | | **Service** | Run Immy Service | Allows you to run target assignments, maintenance actions, install software or onboard a list of computers | | **Sessions** | List Sessions | Get a list of maintenance sessions | | **Software** | List Software | Get a list of software | | **Software** | Get Software | Get a software entry by ID | | **Software** | Upload Software Installer | Upload a new software installer | | **Software** | Analyze Software Installer | Analyze a software installer to automatically gather details about it in ImmyBot | | **Software** | Fast Create Software | Create a software and a corresponding software version from an uploaded installer or URL | | **Software** | Search Inventory Software | Searches across computer inventory for installed software matching the given name | | **Tasks** | Create Task | Creates a new maintenance task in the local environment | | **Tenants** | List Tenants | Retrieve a list of tenants from ImmyBot | | **Tenants** | Get Tenant Preferences | Get preferences for a given tenant in ImmyBot | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.rewst.help/documentation/integrations/integration-guides/immybot-integration-setup.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.