The Get started guide
Set up a new platform one step at a time, from your Claude key to inviting your team.
A new organisation, and every new platform, starts on Get started. It shows every step at once, in the order they can be done. You can do most of them right there.
The card at the top#
The card at the top says whether the platform is ready:
- … isn't ready yet: the first two steps are all the agent needs. The rest make its answers better.
- You're ready: tickets that arrive appear in the Queue. Click Go to the Queue.
A bar under it shows how many steps are done, for example "2 of 5 steps done".
If you signed up free, you can choose a paid plan any time under Your account › Plan & billing. If you chose a paid plan on the pricing page, your organisation is already on it.
The steps#
Each step shows its number, or a tick once it's done, and a label: Needed, Optional or Done.
- 1
Add your Claude key (needed). The agent runs on your own Claude account, so you pay Anthropic directly for what it uses. Create an API key in the Anthropic Console, under API keys. Paste it into Your Anthropic API key and click Save the key. If your organisation already has a Claude key, pick it under Use a key you've already added and click Use this key. Once it's done, you can change it in Settings › Agent.
- 2
What the agent can look at (needed: any one). Tick what this platform's problems can be found in: Code, Kubernetes and logs, Databases, Microsoft 365 or Google Workspace. Many platforms have no code at all, such as an IT company's client that only has Google Workspace. Each ticked one shows its own steps and a button to its settings, and says Connected once it is. For Code: if your organisation has no GitHub or GitLab key yet, add one first with Add a GitHub or GitLab key (it opens Organisation › Keys), then add the repositories in Settings › Code and choose the key that reads each.
- 3
Tell the agent about your system (optional). A few plain sentences in About your system: what the system does, who uses it, and which repository holds what. Click Save. The same text is under Settings › Agent.
- 4
Connect your ticket system (optional). Connect HaloPSA, or your own ticket system through our API. Click Open Ticket system, or How it works to read about it. Once done, the step says HaloPSA is connected. or Your ticket system is connected. Not ready yet? Tickets can also come from errors in your logs, through the Log watcher.
- 5
Invite your team (optional). Enter an Email, pick a Role (Approver, Admin or Viewer) and click Invite. Approvers review the agent's replies. Admins can also change settings. Viewers can only look. Each person gets an email to sign in.
You can come back here any time from the Queue, or change anything later in Settings.
Only owners and admins can use the guide. Until the platform has what the agent needs, the Queue shows a Finish setting up card. Its Step by step button opens this guide.
When the ticket system counts as connected#
- HaloPSA counts as soon as it's connected.
- Your own system counts once it has an address for approved replies and an API key that hasn't been revoked.
See Ticket system.