The CloudRadial AutomationAI IT Glue extension lets a workflow or agent work with your IT Glue documentation: look up organizations, configurations, network interfaces, contacts, locations, documents, domains, and password metadata, and, with approval, create or update organizations, configurations, contacts, locations, and flexible assets. This article covers what the extension can do, the API key it needs, which tools require approval, how it handles passwords, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
Version 1.2.0 adds create and update for organizations, configurations, configuration interfaces, contacts, and locations, nine lookup tools, and three skills. If you already have the extension installed, your workflows and agents pick up the new tools automatically; you do not need to reinstall it.
- What the Extension Covers
- Creating an IT Glue API Key
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Resolving Required Ids
- How the Extension Handles Passwords
- Skills
- Tips for Working With IT Glue Data
What the Extension Covers
The extension calls the IT Glue API and provides 37 tools across these areas:
| Area | What you can automate |
|---|---|
| Organizations | List, search, and read organizations, and create or update an organization |
| Configurations | List and read configurations (assets and devices) by organization, name, type, serial number, or asset tag, and create or update a configuration, including archiving and unarchiving it |
| Network interfaces | List the IP and MAC interfaces on a configuration, find which device owns an IP address, and add or update an interface |
| Contacts | List contacts by organization, first name, last name, or primary email, read a contact, and create or update a contact with its email addresses and phone numbers |
| Locations | List an organization's locations (sites), and create or update a location and its address |
| Flexible assets | List flexible asset types and their fields, list and read flexible assets, and create or update a flexible asset |
| Documents, domains, and passwords | List an organization's documents and domains, and look up password records. Read-only. |
| Lookups | Resolve organization types and statuses, configuration types and statuses, contact types, manufacturers, operating systems, countries, and regions (states and provinces) |
Install it from Extensions like any other catalog extension. It appears in the catalog as IT Glue. See Browsing and installing extensions for the general install flow.
Creating an IT Glue API Key
The extension signs in to IT Glue with an API key, sent on every request.
- Sign in to IT Glue with an Administrator role and go to Admin > Settings
- Select Custom API Keys > Create API Key, then copy the new key
- Leave password access off unless you want the extension to be able to read stored passwords. See How the Extension Handles Passwords before you turn it on.
IT Glue revokes an API key that goes unused for 90 days. If a workflow that runs rarely suddenly fails at sign-in, check that the key is still active.
Providing the Credentials to Your Runner
Store two secrets in your runner's Key Vault with these exact names:
| Secret | Value |
|---|---|
ITGlue-ApiUrl |
The API address for your IT Glue data center: https://api.itglue.com (US), https://api.eu.itglue.com (EU), or https://api.au.itglue.com (Australia) |
ITGlue-ApiKey |
The API key you generated in IT Glue |
Use the API address that matches your account's data center, with no path after it. For how to add these secrets, see Accessing and updating your runner's Key Vault. If you keep a separate IT Glue account per client, see Managing companies and per-company credentials.
The agent reads the credentials from the runner and never asks you for them. Once the secrets are in place, ask the AI Playground to list your IT Glue organizations to confirm the connection works.
Reads and Approval-Gated Changes
Of the 37 tools, 25 are read-only and run without interruption. The other 12 create or change a record, and every one of them is approval-gated: the run pauses and the request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
The approval-gated tools are:
- Create an organization
- Update an organization
- Create a configuration
- Update a configuration, including archiving or unarchiving it
- Add a network interface to a configuration
- Update a network interface
- Create a contact
- Update a contact
- Create a location
- Update a location
- Create a flexible asset
- Update a flexible asset
The extension does not delete anything. To retire a configuration, archive it instead.
Resolving Required Ids
Many IT Glue fields take an id rather than a name: an organization's type and status, a configuration's type, status, manufacturer, and operating system, a contact's type, and a location's country and region. A configuration type is required when you create a configuration. The extension ships nine lookup tools that fetch these ids from your own IT Glue account, so an agent never has to guess one.
When you build a workflow that creates IT Glue records, put the matching lookup ahead of the create step so the id comes from live data rather than being hard-coded. For example, look up the country by its two-letter ISO code (such as US) and then the region by its code within that country before you create a location.
How the Extension Handles Passwords
The password tools are read-only. The extension cannot create, change, or delete a password record. Agents are instructed to report only a password record's id, name, username, category, URL, and organization, and to decline if you ask for the password itself.
- Reading a single password record does not return the stored password, even when your API key has password access
- Listing password records can return the stored passwords if your API key has password access. The agent is told not to repeat them, but the values still reach the agent.
If you do not need the extension to work with passwords, leave password access off on the API key. That is the only setting that keeps stored passwords out of a password list. Password records also include their notes, so avoid keeping secrets in the notes field.
Skills
The extension ships eight skills that guide an agent through common IT Glue tasks:
| Skill | Use it to |
|---|---|
| Look up Organizations and Configurations | Find an organization and list or read its configurations (managed assets and devices). Read-only. |
| Find Contacts and Locations | Find an organization's contacts by first name, last name, or email, and its locations. Read-only. |
| Inventory Network Devices | List an organization's network devices and their IP interfaces, or find which device owns an IP address. Read-only. |
| Retrieve Documentation and Passwords | Find an organization's documents and password-record metadata. Read-only; password values are never reported. |
| Manage Flexible Assets | Read, create, or update flexible-asset documentation. The agent looks up the flexible asset type and its field names first. Writes are approval-gated. |
| Manage Organizations | Create or update an organization. The agent searches for the organization by name first and updates it instead of creating a duplicate. Writes are approval-gated. |
| Manage Configurations | Create or update a configuration and its IP and MAC interfaces. The agent searches by serial number, asset tag, or name first and updates an existing record instead of creating a duplicate. Writes are approval-gated. |
| Manage Contacts and Locations | Create or update an organization's contacts and locations. The agent searches for an existing contact by email, then by name, and for an existing location by name, and updates instead of creating a duplicate. Writes are approval-gated. |
To give an agent these skills, see Creating custom agents and using them in workflows.
Tips for Working With IT Glue Data
- Refer to organizations by name and let the agent look up the id. It searches and matches rather than guessing.
- When you update a contact's email addresses or phone numbers, the new list replaces the old one. The agent sends every entry you want to keep, not only the one you change.
- Each contact email address and phone number needs a label name as well as the value; IT Glue rejects an entry without one
- Organizations, contacts, and locations that sync from your PSA, and configurations that sync from your PSA or RMM, may reject changes to synced fields. IT Glue rejects any update to an organization that is syncing with a PSA. Make those changes in the source system instead; the agent reports the error rather than retrying.
- Changing the primary IP address of an interface that syncs from another system also fails. Change it at the source.
- List tools return the complete result in one call, so you do not pass a page number. For large accounts, filter by organization to keep results focused.
- IT Glue allows 3,000 API requests per five minutes. A workflow that loops over many records can hit that limit, so filter lists rather than reading records one at a time where you can.
- If every call fails, check that
ITGlue-ApiUrlmatches your data center and that the API key has not been revoked
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.