The CloudRadial AutomationAI NinjaOne PSA extensions let a workflow or agent work with the service-desk and documentation side of NinjaOne: tickets, billing accounts, agreements, invoices, and products, knowledge base articles, organization documents, document templates, related items, and checklists. The PSA API is split across three extensions plus a Read-Only version. This article covers which to install, connecting them to a NinjaOne API application, which tools require approval, and the skills that ship with them. It is for workspace users who build automations (Admin or Owner Role).
- Choosing Which Extensions to Install
- What the Extensions Cover
- Creating the NinjaOne API Application
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With NinjaOne PSA
Choosing Which Extensions to Install
The NinjaOne PSA extensions come in four versions in the catalog:
| Extension | Tools | Install it for |
| NinjaOne PSA — Ticketing & Billing | 43 tools: 18 reads and 25 writes | Service-desk tickets, comments, boards, and forms, and billing: accounts, agreements, invoices, products, and the products on a ticket |
| NinjaOne PSA — Documentation & Knowledge | 36 tools: 18 reads and 18 writes | Knowledge base articles, organization documents, document templates, and related items in NinjaOne Documentation |
| NinjaOne PSA — Checklists | 10 tools: 4 reads and 6 writes | Organization checklists and reusable checklist templates in NinjaOne Documentation |
| NinjaOne PSA (Read-Only) | 40 tools, all reads | A strict read-only connection, or a NinjaOne API application that has only the Monitoring scope |
All NinjaOne extensions, including the NinjaOne RMM extensions, use the same three secrets, so you configure them once and every NinjaOne extension you install works. Install the extensions you need from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
Staying Within the Tool Limit
An agent run can load at most 128 tools, which is why NinjaOne is split into several extensions. The three PSA extensions together have 89 tools and fit in one run. Adding NinjaOne RMM extensions to the same agent can take it over the limit, so scope each agent to only the extensions its task needs. See Creating custom agents and using them in workflows.
When to Choose Read-Only
Choose NinjaOne PSA (Read-Only) when agents should only look up and report, or when your NinjaOne API application has only the Monitoring scope. The three standard extensions request the Monitoring, Management, and Control scopes, so they need an API application that allows all three. Read-Only requests only Monitoring, which NinjaOne defines as read-only access to monitoring data and organization structure. It contains every read tool from the three standard extensions, unchanged, and none of their write or delete tools.
Install Read-Only instead of the three standard PSA extensions, not beside them. They share tool names, so an agent scoped to both would call a shared tool with whichever extension's connection settings loaded last. If you do have both in one workspace, never scope an agent to both. NinjaOne PSA (Read-Only) and NinjaOne RMM (Read-Only) together have 146 tools, more than one run can load, so give the RMM and PSA sides separate agents.
What the Extensions Cover
The extensions call the NinjaOne Public API v2. The tables below group each standard extension's tools by area.
NinjaOne PSA — Ticketing & Billing
| Area | Tools | What you can automate |
| Tickets | 13 | Read a ticket and its log entries, list boards and a board's tickets, read ticket forms, attributes, and statuses, list contacts and users by type, create and update tickets, and add comments |
| Billing accounts | 5 | Read accounts, and create, update, and delete them |
| Agreements | 4 | Read agreements, and update or deactivate them |
| Invoices | 9 | Read invoices, create and update them, update an invoice note, and approve, archive, unarchive, or export invoices |
| Products | 6 | Read products, and create, update, activate, or deactivate them |
| Ticket products and time entries | 6 | Read the products on a ticket, add ad hoc or catalog products, update or remove them, and update the PSA properties of a ticket time entry |
NinjaOne PSA — Documentation & Knowledge
| Area | Tools | What you can automate |
| Knowledge base articles | 11 | List global and organization articles, browse folders, download articles and related attachments, get signed download links, upload articles and temporary attachments, and move items |
| Organization documents | 8 | List documents with their field values, get signed download links, create and update documents, and archive, restore, or delete an archived document |
| Document templates | 7 | List and read templates with their fields, create and update templates, and archive, restore, or delete them |
| Related items | 10 | List related items by host or related entity, create attachment, entity, and secure relations, and delete related items |
NinjaOne PSA — Checklists
| Area | Tools | What you can automate |
| Organization checklists | 6 | List and read an organization's checklists, get signed download links, and archive, restore, or delete checklists |
| Checklist templates | 4 | List templates, and archive, restore, or delete them |
NinjaOne PSA (Read-Only)
Read-Only has 40 read tools from the three tables above: 18 from Ticketing & Billing, 18 from Documentation & Knowledge, and 4 from Checklists.
Creating the NinjaOne API Application
The extensions sign in with OAuth client credentials. The runner exchanges a NinjaOne API application's Client ID and Client Secret for a short-lived access token and caches it. If you already set up an API application for the NinjaOne RMM extensions, the PSA extensions use the same one. Otherwise, in NinjaOne, go to Administration > Apps > API, open the Client App IDs tab, and add a client app. For Application Platform, select API Services (machine-to-machine), enable the Client Credentials grant type, and choose its scopes. NinjaOne defines the scopes as:
- Monitoring: read-only access to monitoring data and organization structure
- Management: modification of device and organization information
- Control: remote access through the API
NinjaOne's API reference does not say which scope the ticketing, billing, documentation, and checklist endpoints require. The three standard extensions request all three scopes when they sign in, so the API application must allow all three. NinjaOne PSA (Read-Only) requests only Monitoring, so an application that allows only Monitoring is enough for it to sign in. Copy the application's Client ID and Client Secret. For NinjaOne's own steps, see API OAuth Token Configuration.
Providing the Credentials to Your Runner
Store three secrets in your runner's Key Vault with these exact names. Every NinjaOne extension, RMM and PSA, uses the same secrets, so skip this step if they are already there.
| Secret | Value |
NinjaOne-ApiUrl |
The NinjaOne host you sign in to, with no trailing slash, for example https://app.ninjarmm.com. Regional hosts are eu.ninjarmm.com, ca.ninjarmm.com, oc.ninjarmm.com, and us2.ninjarmm.com. |
NinjaOne-ClientId |
The Client ID of the API application |
NinjaOne-ClientSecret |
The Client Secret of the same application |
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
Tools that only read run without interruption. Every tool that changes something in NinjaOne 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.
| Extension | Run without approval | Approval-gated |
| Ticketing & Billing | 18 reads | 25 writes, including listing a board's tickets |
| Documentation & Knowledge | 18 reads | 18 writes |
| Checklists | 4 reads | 6 writes |
| Read-Only | 40 reads | None |
Listing the tickets on a board asks for approval in Ticketing & Billing, because the extension treats that call as a write. For the same reason it is not in Read-Only, which can read a ticket by its id but can't list a board's tickets.
Before a write, check the organization, the record, and the change the agent names. Take extra care with requests that:
- Delete a billing account, an archived document, a document template, a checklist, or related items
- Approve, archive, or export invoices
- Update or deactivate an agreement or a product
- Create a secure relation
Skills
Each standard extension ships one skill per area of the API, eight in all:
| Skill | Extension | Use it to |
| NinjaOne — ticketing | Ticketing & Billing | Read, create, and update tickets, add comments, and look up boards, forms, statuses, and contacts |
| NinjaOne — Billing | Ticketing & Billing | Work with billing accounts, agreements, invoices, products, and the products on a ticket |
| NinjaOne — Knowledge Base Articles | Documentation & Knowledge | Browse, download, upload, and move knowledge base articles |
| NinjaOne — Organization Documents | Documentation & Knowledge | List, create, update, archive, restore, and delete organization documents |
| NinjaOne — Document Templates | Documentation & Knowledge | Read and manage document templates |
| NinjaOne — Related Items | Documentation & Knowledge | Read and manage the relations between items, including attachments and secure relations |
| NinjaOne — Organization Checklists | Checklists | Read, archive, restore, and delete an organization's checklists |
| NinjaOne — Checklist Templates | Checklists | List, archive, restore, and delete checklist templates |
NinjaOne PSA (Read-Only) ships eight matching skills named NinjaOne: area, for example NinjaOne: ticketing. Each covers only that area's read tools.
Tips for Working With NinjaOne PSA
- Lists return results in batches rather than numbered pages. To get the next batch, pass the id of the last item from the previous one.
- Organization ids are numbers. Refer to organizations by name and let the agent look up the id.
- If you use NinjaOne PSA (Read-Only), try a simple read in the AI Playground first to confirm that your Monitoring-only API application can reach the tickets, documents, and checklists you need. NinjaOne does not document which of these reads a Monitoring-only token can make. See Testing your setup in the AI Playground.
- If calls fail, check that
NinjaOne-ApiUrlis the host you sign in to, with no trailing slash, and that the API application allows the scopes the extension requests: all three for the standard extensions, Monitoring for Read-Only
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.