HaloPSA

HaloPSA Integration Guide

Introduction

HaloPSA Integration will allow you to create issues with the detailed data per customer when the action will be called.

Prerequisites

  • A HaloPSA Agent account with required privileges.

  • API credentials (Application) with required permissions.

Required Privileges for Agent Account

Tickets Access Level

Read and Modify

Clients Access Level

Read Only

Users Access Level

Read Only

Assets Access Level

Read Only

Can add new Tickets

Yes

Can edit closed Tickets

Yes

Can view Unassigned Tickets

Yes

Can view Tickets that are assigned to other Agents

Yes

Can change a Ticket's Ticket Type

Yes

Can Re-assign Tickets

Yes

Can Edit Advanced Ticket Details

Yes

Editing of Actions

Can Edit Own Actions Only

Can assign to Agents in Teams the Agent is not a member of

Yes

Can Edit Tickets Which Are Not Assigned To Them

Yes

Can always update Ticket Statuses and re-assign Tickets outside of actions

Yes

Allow use of all Asset Types

Yes

Allow use of all Ticket Types

Yes

Allow use of all Asset Fields

Yes

To create an Agent Account, follow these steps:
  1. Login to HaloPSA Agent Portal

  2. Go to Configuration → Teams & Agents → Agents.

  3. Click “+ New”

  4. Add username : Perimeters and click “Save”

  5. Go to the “Permissions” tab and click “Edit”.

  6. Select the Agent Permissions

  7. Click “Save”

  8. Click “edit” in the “Departments & Teams” tab.

  9. In the Teams section, click “+ Add” and select the teams you want to add perimeters to and send tickets to and click “Save”.

Required Permissions for API Credentials (Application)

Scope
Usage

read:tickets

Read tickets that are opened by perimeters

edit:tickets

Create and update tickets

read:customers

Read Customer Inventory

read:assets

Read Asset Inventory

read:projects

Read Projects

all:teams

Read Teams and Members

To create API Credentials (Application), follow these steps:
  1. Login to HaloPSA Agent Portal.

  2. Navigate to Configuration → Integrations → HaloPSA API → View Applications.

  3. Click "+ New".

  4. Fill the following information:

    • Application Name: Perimeters

    • Authentication Method: Client ID and Secret (Services)

    • Login Type: Agent

    • Agent to login in as: Perimeters (Agent created via following perimeters' instructions from the previous step.)

  5. Make sure to copy your Client ID and Client Secret. Once you are finished, navigate to the Permissions tab.

  6. Select the following permissions:

    • read:tickets

    • edit:tickets

    • read:customers

    • read:assets

    • read:projects

    • all:teams

  7. Click Save at the top left to finish creating the Application.

Onboarding HaloPSA in your Perimeters account

  1. Go to Integrations → Response and Automation → Select "HaloPSA" -> Click "+ Add" -> Click "+ Start Integration".

  2. "Namespace" - Fill in the domain name for your HaloPSA instance. For example, if your HaloPSA domain name is "perimeters.halopsa.com" you would enter "perimeters" in this field.

  3. "Client ID" - Provide the Client ID that was create in earlier steps.

  4. “Client Secret” - Provide the Client ID that was create in earlier steps.

  5. Click "Finish" to complete the onboarding process.

Once you have completed these steps, HaloPSA should be successfully integrated with your Perimeters account.

Last updated