Connecting your HaloPSA instance to CloudRadial ServiceAI enables you to import tickets and documentation for summarization, analysis, recommendations, and more. You can also surface ServiceAI directly inside HaloPSA as a Custom-Tab pod so technicians get AI ticket summaries, related tickets, related KB articles, and one-click Pod Quick Actions without leaving the PSA.
Follow the instructions below to learn how to set up the API member for ServiceAI:
- Creating and Configuring an API Key in HaloPSA
- Configuring Ticket Systems in ServiceAI
- Configuring Article Systems
- Using Triage With HaloPSA
- Setting Up the ServiceAI Pod in HaloPSA
Creating and Configuring an API Key in HaloPSA
- Log in to your HaloPSA instance
- Select the Configuration option
- Search for and select Integrations > HaloPSA API
- Under the Applications section, select the View Applications button
- Select the + New button at the top right
- Complete the following configuration options to generate an appropriate API key:
- Application Name: ServiceAI
-
Authorization Method: Select Client ID and Secret (Services)
- Your Client ID and Client Secret keys will appear.
- Copy them as they will not be visible after this step.
- Login Type: Agent
- Agent to log in as: Select an existing system admin within your HaloPSA instance with full permissions
- Next, navigate to the Permissions tab at the top and select the following permissions:
- read:tickets
- read:customers
- read:items
- read:reporting
- read:kb
- edit:kb
- read:assets
- admin
- Select the Save button to finalize your changes
Configuring Ticket Systems in ServiceAI
Ticket Systems are the ServiceAI mechanism for gathering and analyzing ticket data for various functions. This is a core requirement to get the most value and insights from ServiceAI.
- Log in to ServiceAI and select the Settings gear at the top
- Select the Setup option
- Under Ticket System Configuration, select Halo as your ticketing system and enter the required fields:
- Client Id: Enter your Client Id key created previously
- Client Secret: Enter your Client Secret key created previously
- Domain URL: Enter your HaloPSA URL (e.g., https://domain.halopsa.com)
- Select Test Connection to ensure that the system is correctly provisioned for setting up your HaloPSA tenant with ServiceAI.
Select Save Changes at the bottom to finalize your setup.
Configuring Article Systems
Article Systems are the ServiceAI mechanism for writing knowledge base articles to your KB of choice, which can help build a robust system of processes and information for end users and internal users alike.
- Log in to ServiceAI and select the Settings gear at the top
- Select the Setup button
- Under Article System Configuration, select Halo and enter the required fields:
- Client Id: Enter your Client Id key created previously
- Client Secret: Enter your Client Secret key created previously
- Domain URL: Enter your HaloPSA URL (e.g., https://domain.halopsa.com)
- Select Save Changes to finalize the setup of Halo to ServiceAI.
In a few minutes, knowledge base data will begin to sync into the system.
Using Triage With HaloPSA
Once your HaloPSA ticket system is configured, ServiceAI's Triage feature can process incoming HaloPSA tickets automatically. HaloPSA triage uses the Unified Triage Rules model — a single set of rules drives routing, categorization, and assignment decisions in one combined AI analysis per ticket.
Webhook Setup
ServiceAI creates the HaloPSA webhook for you when you save your Triage settings, so you do not need to copy a URL into HaloPSA.
- In ServiceAI, go to Settings > Triage Settings and enable Triage
- Select at least one Monitored Team
- Select Save Settings
ServiceAI then adds a webhook to HaloPSA under Configuration > Integrations > Webhooks. Its name begins with ServiceAITriage-, and it sends New Ticket Logged events to ServiceAI. Only new tickets are sent, so editing an existing ticket does not trigger Triage again.
If you turn Triage off, or save with no Monitored Teams selected, ServiceAI removes the webhook it created. A webhook you created yourself is never removed. If you already have an active webhook for New Ticket Logged that points at your ServiceAI webhook URL, ServiceAI uses it instead of creating a second one, so tickets are not triaged twice.
If you regenerate the secret in ServiceAI, select Save Settings afterward so ServiceAI points the webhook it created at the new URL.
If HaloPSA does not allow the API application to manage webhooks, ServiceAI still saves your settings and shows a message that webhook configuration failed. The message explains what to change in HaloPSA. You can also set up the webhook manually.
If You Prefer to Set Up the Webhook Manually
Use these steps if automatic setup fails or you would rather create the webhook yourself. ServiceAI generates a webhook URL and a shared secret that you copy into HaloPSA.
- In ServiceAI, go to Settings > Triage Settings and enable Triage
- Locate the Webhook Setup section. Copy the webhook URL using the Copy URL button
- In HaloPSA, go to Configuration > Integrations > Webhooks, click New and set up the webhook:
- Paste the copied URL into the Payload URL field
- Set the type to Standard Webhook, the method to POST and the content type to application/json
- Set Authentication to None
- Add an event for New Ticket Logged, then save the webhook
- If you regenerate the secret in ServiceAI, the new URL becomes active immediately — update the webhook configuration in HaloPSA before the next ticket arrives
Saving Triage Settings does not rotate the secret — only the Regenerate Secret button does.
HaloPSA-Specific Triage Behavior
- Routing rules target HaloPSA Teams. The routed team is written to the ticket's Team field.
- Categorization rules map to HaloPSA's Category 1 and Category 2 fields. Each level is matched against its own list of HaloPSA categories, and both are set on the ticket in the same update.
- If HaloPSA rejects an update, ServiceAI writes the fields in smaller updates so everything HaloPSA accepts still applies. When the rejection is a category error (for example, a Category 2 value that is a resolution category, which HaloPSA won't set on an open ticket), ServiceAI writes all the other fields together first and then each category on its own, so one refused field does not block priority, ticket type, team, agent or subject. For any other rejection, ServiceAI writes one field at a time. Fields HaloPSA refuses, or accepts but does not set on the ticket, appear in Triage Details as Rejected, with HaloPSA's reason when it gives one.
- The ticket subject can be updated from the AI's improved subject suggestion
- Picklist values are auto-discovered from your HaloPSA instance; no manual list maintenance is required
- Triage posts its decision as an internal note on the ticket. The note includes a Related tickets and Related KB articles section with clickable links to the matching items in your HaloPSA instance and ServiceAI
- If your HaloPSA instance also runs HaloPSA's built-in AI Auto Triage runbook, both it and ServiceAI can write the ticket category, and whichever writes last wins. Before you turn off Testing Mode, either narrow the runbook's trigger criteria so the two don't overlap, or clear the category fields the runbook sets (usually Category 1) under Field Updates in ServiceAI's Triage settings.
Setting Up the ServiceAI Pod in HaloPSA
The ServiceAI pod surfaces inside HaloPSA as a Custom Tab on the ticket form. When a tech opens a ticket, the pod shows the AI ticket summary, a Related blade (related tickets and KB articles linking back to your HaloPSA instance and ServiceAI), and a horizontal strip of Pod Quick Actions — configurable one-click prompts that send context-anchored questions to ServiceAI.
Adding the Custom Tab in HaloPSA
- In HaloPSA, go to Configuration > Custom Objects > Custom Tabs and Click New (top right)
- Open the Custom Tabs section and add a new tab named ServiceAI
-
Set the tab content to an iframe pointing at your ServiceAI Ticket Pod URL. To get it, in ServiceAI go to Settings > Overview, find the Halo Pod Installation section and click Copy beside Ticket Pod URL. The URL looks like this:
https://[region].serviceai.app/halo-ticket?tenantGuid={tenant_guid}&ticketId=$FAULTID&agentId=$LOGGEDINAGENTID&hmac=$HMAC(The copied URL already contains your region and Tenant GUID. HaloPSA replaces
$FAULTIDwith the ticket ID,$LOGGEDINAGENTIDwith the agent viewing the ticket, and$HMACwith a signature over that agent's ID, which ServiceAI uses to sign the agent in automatically. Paste the URL exactly as copied: HaloPSA passes an unrecognized variable through as plain text without reporting an error, so a mistyped variable silently stops automatic sign-in.) - Save the ticket type. The next time a tech opens a ticket of that type, the ServiceAI tab will be available
Allowing the Tab on Your Ticket Types
Creating the tab does not place it anywhere. It must also be allowed on each ticket type that should display it, or the tab will not appear.
- Go to Configuration > Tickets > Ticket Types and open a ticket type
- Click the Allowed Values tab in the top row, then click Edit
- Scroll to the Custom Tabs section
- Either set Allow all Custom Tabs to Yes, or set it to No and add ServiceAI to the list beneath it
- Click Save
- Repeat for each ticket type that should show the pod
The next time a tech opens a ticket of that type, the ServiceAI tab will be available.
Turning On Automatic Sign-In
Automatic sign-in lets techs open the ServiceAI tab without signing in to ServiceAI separately. HaloPSA signs the ID of the agent viewing the ticket with a secret that only your HaloPSA Custom Tab and ServiceAI hold, and ServiceAI checks that signature before signing the agent in. Automatic sign-in requires HaloPSA v2.252 or later. On earlier versions, the pod still works, but techs sign in to ServiceAI inside the tab on first use.
- In HaloPSA, open the ServiceAI Custom Tab and tick Send secure URL parameter. HaloPSA generates an Iframe Secret for the tab.
- Copy the Iframe Secret
- In ServiceAI, go to Settings > Overview and find the Halo Pod Installation section
- Paste the secret into the Iframe Secret field beside Ticket Pod URL and click Save
Both sides must hold the identical value. Once saved, the secret can't be viewed in ServiceAI; the field just confirms that a secret is stored. To replace it, paste a new value and click Save. Leaving the field blank keeps the stored secret. You enter the secret here after the Halo integration has been added, not during Add Integration. Removing the Halo integration also removes the stored secret.
Once the secret is saved, a tech who opens the tab is signed in automatically when their HaloPSA email address matches an active ServiceAI team member. A tech who hasn't appeared on a synced ticket yet is looked up in HaloPSA the first time they open the tab. Agents who are disabled in HaloPSA are not signed in automatically.
If automatic sign-in can't complete, the tab opens the ServiceAI sign-in page instead, usually after briefly showing the reason and a Reference: ID you can quote to support. Failed attempts aren't remembered, so once the problem is fixed, the tech is signed in automatically the next time they open a ticket. The messages you're most likely to see are:
- This HaloPSA version does not support automatic sign-on for Custom Tabs. HaloPSA didn't fill in the agent ID or signature, either because it's earlier than v2.252 or because a variable in the tab's URL was mistyped.
- ServiceAI is not yet set up for automatic sign-on from HaloPSA. No Iframe Secret is saved in ServiceAI.
- The email address '<email>' is not set up as a team member in ServiceAI. The tech's HaloPSA email address doesn't match an active ServiceAI team member. Add or reactivate them as a ServiceAI team member, or correct the address on either side so the two match.
- Auto-login failed. Please use the standard login. The signature couldn't be verified. Check that the Iframe Secret saved in ServiceAI matches the one on the Custom Tab, and that the tab uses the current Ticket Pod URL.
If your Custom Tab was set up with an earlier ServiceAI URL (one without agentId and hmac), it still loads the pod, but techs have to sign in manually until you replace it with the current Ticket Pod URL.
Checking Which Agents Can Sign In
Administrators can see which HaloPSA agents the pod can sign in under Settings > Pod access. If no Iframe Secret is saved, the page shows the warning Automatic sign-on is not set up yet. Until the secret is saved, no agent is signed in automatically, whatever the table shows.
A summary line shows how many agents have a mapping that needs fixing, how many have no synced email address (the pod checks HaloPSA directly for those) and how many are disabled in HaloPSA (the pod refuses these agents by design). The table lists each agent with these columns:
- Agent, Email and Halo agent (the agent's HaloPSA ID)
- Pod access: Working, Disabled in Halo, No email or Blocked
- What to fix: what's stopping that agent from being signed in
Show only agents with a problem is on by default and hides agents who are working or disabled in HaloPSA. Click Refresh to check again after you make a change. Only agents synced from HaloPSA are listed, so an agent missing from the list isn't necessarily blocked. An agent who hasn't appeared on a synced ticket yet is looked up in HaloPSA the first time they open the tab.
Pod Behavior
- With automatic sign-in turned on, techs are signed in automatically when they open the tab. Without it (HaloPSA earlier than v2.252, or no Iframe Secret saved in ServiceAI), the first time a tech opens the pod in a new session, they sign in to ServiceAI inside the tab. Microsoft and Google sign-in cannot open inside the HaloPSA tab. If your organization signs in with Microsoft or Google, select Email me a sign-in code and enter the 6-digit code that ServiceAI emails you.
- If the ticket already has a ServiceAI conversation, the pod reopens the most recent conversation for that ticket so the technician can pick up where it left off. To start fresh instead, click + beside the chat input and select New Conversation.
- Select Refresh analysis in the pod's top bar, next to Summary and Related, when a ticket has changed since ServiceAI last looked at it. ServiceAI re-reads the ticket from HaloPSA, runs the ticket analysis again and posts a fresh technical summary to the chat. Nothing is changed in HaloPSA. Refreshing uses AI credits and requires the Editor role or higher on Tickets. For details, see Adding ServiceAI In-PSA Assistance for Your Technicians.
- The pod theme matches HaloPSA's white / dark-gray palette and uses the Poppins font
- Light or dark mode follows the user's ServiceAI preference
- The pod runs every chat turn through the same agentic, search-augmented workflow as AI Chat — instead of giving a one-shot answer, it can pull related tickets, look up KB articles, and follow up with tool calls
Configuring Pod Quick Actions
The configurable strip of one-click pills under the pod's launcher is managed per tenant under Settings > AI Behavior > Pod Quick Actions. The same configuration applies to every supported PSA pod (HaloPSA, ConnectWise, Autotask, Zendesk).
For full details on enabling Triage, building rule sets, and viewing triage results, see All About ServiceAI's Triage Feature. For webhook diagnostics, see Troubleshooting Triage Webhook Configuration.
Comments
0 comments
Article is closed for comments.