The CloudRadial AutomationAI Kaseya BMS extension lets a workflow or agent work with your Kaseya BMS (PSA) data: triage and manage service desk tickets and their notes, look up and create accounts (companies) and contacts, look up account locations and technicians, read lookup values such as queues, statuses, priorities, and work types, and log time against a ticket. This article covers what the extension can do, the runner version and credentials 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).
The Kaseya BMS extension requires a runner on version 2.4.0 or later. An earlier runner cannot sign in to Kaseya BMS, so every call fails with a 401 error. See Upgrading a runner to a new version.
- What the Extension Covers
- How the Extension Signs In
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With Kaseya BMS Data
What the Extension Covers
The extension calls the Kaseya BMS V2 REST API and provides 18 tools across these areas:
| Area | What you can automate |
| Tickets | List service desk tickets, filtered by title text, ticket number, account, status, queue, or priority name, assignee, open date, or open tickets only; read a ticket; and create or update a ticket, including assigning it |
| Ticket notes | Read the notes on a ticket and add a note, internal or not |
| Accounts and contacts | List and read CRM accounts (companies) and contacts, list an account's locations, and create an account or contact |
| People | List the technicians and other users a ticket can be assigned to, and the roles each one can log time under |
| Lookups | Read lookup lists to resolve ids for queues, statuses, priorities, issue types, account types, work types, and roles |
| Time | List time logs, filtered by ticket, user, account, or date range, and log time against a ticket |
Install it from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
How the Extension Signs In
Kaseya BMS has no static API key. The runner signs in for you: it sends the username, password, and company name of a BMS user to Kaseya BMS, receives a short-lived access token, and sends that token on every call. It keeps the token for later calls, and if Kaseya BMS rejects it, the runner signs in again on the next call. The agent never signs in itself and never asks you for credentials.
Use a dedicated API integration account in Kaseya BMS for this, rather than a technician's own sign-in:
- In Kaseya BMS, go to HR > Employees, create an employee, and set its User Type to Api Employee. Give it a valid email address, which it needs to set its password.
- Set the account's password. Select the API user and choose Reset and Send instructions; the link it receives lets you create the password you store in Key Vault.
- If the account's security role isn't Administrator, turn on API access for that role under Admin > Security > Roles > Admin.
An API Employee can't sign in to the Kaseya BMS web interface and doesn't use a license. For details, see Kaseya's Dedicated API integration account in PSA.
Providing the Credentials to Your Runner
Store five secrets in your runner's Key Vault with these exact names:
| Secret | Value |
KaseyaBMS-ApiUrl |
The API base URL for your Kaseya BMS region: https://api.bms.kaseya.com (US), https://api.bmsemea.kaseya.com (EMEA), or https://api.bmsapac.kaseya.com (APAC) |
KaseyaBMS-Username |
The username of the BMS API user |
KaseyaBMS-Password |
That user's password |
KaseyaBMS-CompanyName |
Your Kaseya BMS tenant (company) name |
KaseyaBMS-AccessToken |
Any placeholder value. The extension does not use this secret to sign in, but it must exist. |
For how to add these, see Accessing and updating your runner's Key Vault. If you work in a separate Kaseya BMS tenant for a client, see Managing companies and per-company credentials.
Reads and Approval-Gated Changes
Of the 18 tools, 12 are read-only and run without interruption. The other 6 create or change something, 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.
| Tool behavior | Tools |
| Approval-gated | Create a ticket; update a ticket; add a ticket note; create an account; create a contact; log time |
| Read-only | List and read tickets, ticket notes, accounts, and contacts; list an account's locations; list assignable users and their roles; read lookup lists; list time logs |
A ticket update changes only the fields in the request, such as the assignee, status, queue, priority, or title; every other field on the ticket keeps its value. The extension has no delete tools.
Skills
The extension ships four skills that guide an agent through common Kaseya BMS tasks:
| Skill | Use it to |
| Manage Kaseya BMS Tickets | Find, read, open, update, or add notes to a service desk ticket. Creating, updating, and adding notes are approval-gated. |
| Look Up Accounts and Contacts | Find or read an account (company) or contact, or create a new one. Creates are approval-gated. |
| Read Kaseya BMS Lookup Data | Resolve the ids other tools need: queues, statuses, priorities, issue types, account types, work types, and roles, plus an account's locations and assignable users. Read-only. |
| Log Time on a Kaseya BMS Ticket | Record work time against a ticket or review existing time logs. Logging time is approval-gated. |
Tips for Working With Kaseya BMS Data
- Refer to accounts, queues, statuses, priorities, and people by name. The agent resolves each id before it creates or updates a record, and it does not invent ids.
- Creating a ticket needs the account, a location, a status, a priority, a ticket type, and a source. The agent uses the account's main location unless you name another.
- Kaseya BMS has no lookup list for ticket types, ticket sources, note types, business types, or email and phone types. The agent reuses the value from an existing record of the same kind, such as a recent ticket for the account, an existing note on the ticket, or an existing account or contact. To control the value, pass the id from your workflow.
- Mark a note as internal when the customer should not see it
- Logging time needs the date, a start and end time, a work type, and a role. If you give only a duration, also give a start time.
- Creating an account needs an account type, a business type, and an account manager. The account is created with one main location; give the agent an address for it if you have one.
- Creating a contact needs the account and a location. Including an email or phone number also needs its type, which the agent copies from an existing contact.
- List tools return results a page at a time, so ask the agent to search by account, status, queue, or text rather than to list everything. Kaseya BMS allows 1,500 calls per hour for each endpoint.
- If calls fail at sign-in, check the
KaseyaBMS-Username,KaseyaBMS-Password, andKaseyaBMS-CompanyNamesecrets - If every call fails with a 401 error, check that your runner is on version 2.4.0 or later
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.