Skip to content
BackupSentinel
Start free trial
Documentation menu

HaloPSA setup

Create the API application, connect it, map clients.

Last updated

Connect HaloPSA so BackupSentinel incidents open, update and close HaloPSA tickets. How tickets behave is described in PSA ticketing.

Before you start

You need a HaloPSA administrator to create an API application, and BackupSentinel's Growth or Pro plan (or the free trial).

1. Create the API application in HaloPSA

  1. In HaloPSA, open Configuration → Integrations → Halo API. Note the Resource Server, the Authorisation Server and, on hosted HaloPSA, the Tenant.

  2. Choose View Applications → New.

  3. Name it BackupSentinel and set Authentication Method to Client ID and Secret (Services).

  4. Under Login type, choose a dedicated agent for BackupSentinel or Application identity. Tickets and notes are recorded as that identity.

  5. On the Permissions tab, give it at least:

    • Ticket modify (to create, update, add notes and close)
    • Customers read
    • Read access to teams, ticket types and statuses

    Access is also limited by the agent's own permissions.

  6. Save, then copy the Client ID and the Client Secret.

2. Connect it in BackupSentinel

In Settings → Integrations → PSA ticketing → HaloPSA, enter:

FieldValue
HaloPSA URLThe address you sign in to, e.g. https://yourcompany.halopsa.com.
Authorisation serverOnly if Halo API shows a different one; otherwise /auth on your URL is used.
TenantHosted HaloPSA only.
Client ID, Client secretFrom step 1.
ScopeLeave empty for all, or list the permission names you granted.

Choose Connect and test. BackupSentinel requests an access token (OAuth 2.0 client credentials) and reads your ticket statuses.

3. Map and switch on

  • Team, Ticket type, Status for new tickets: where new tickets go.
  • Status when the backup recovers: a closed status, to close tickets automatically. Leave it empty to only add a note.
  • Status when an incident is reopened: an open status.
  • Priorities: chosen from HaloPSA's list when your instance offers one, otherwise the priority id from HaloPSA's SLA settings.

Then map clients to HaloPSA customers and switch on, as in PSA ticketing.

Good to know

  • HaloPSA allows 700 API requests per 5 minutes per tenant. Ticket updates for one connection are sent one at a time, and BackupSentinel backs off on HTTP 429.
  • Notes are private actions ("hidden from user") unless you turn Keep notes internal off.
  • The ticket link opens https://yourcompany.halopsa.com/tickets?id=<ticket>.