Connecting to HaloPSA

All of the tasks in the HaloPSA connector require an established connection, so you will need to create one before you start building your integration. See Managing Connections for further information.

Setting up an API application in HaloPSA

Before creating the connection in Zynk, you need to register an API application in HaloPSA. Go to Configuration > Integrations > Halo API, then click 'View Applications' and add a new application.

Warning

Set the application's Authentication Method to 'Username & Password'. Do not use 'Client ID and Secret (Services)'.

Zynk authenticates using the OAuth 2.0 Resource Owner Password Credentials grant (grant_type=password), passing a Client ID, username and password. It does not use the client credentials grant, and there is no Client Secret field on the Zynk connection. An application configured for any other authentication method will reject Zynk's login attempt.

On the application's Permissions tab, grant the all scope. Zynk requests all when it authenticates, so the application must be permitted to use it.

The username and password you give to Zynk are those of a HaloPSA agent, so make sure that agent has permission to access the records your integration reads and writes. The agent must also be able to sign in with a password alone — if multi-factor authentication or single sign-on is enforced for that agent, authentication will fail.

Settings

The following settings are required to successfully connect to the HaloPSA platform.

Solution

The edition of HaloPSA that you are licensed for, either Hosted or On Premise.

Environment

The environment you are working in, either Production or Sandbox.

URL

The URL to access your HaloPSA portal.

Client ID

The identifier for your HaloPSA account. Go to Management > API Configuration to find your Client Id.

Username

The username you use to login to your HaloPSA portal.

Password

The password you use to login to your HaloPSA portal.

Common connection errors

This client application is not allowed to use the specified grant type

The HaloPSA API responded with status code 400 (BadRequest):
{"error":"unauthorized_client","error_description":"This client application is not allowed to use the specified grant type."}

The Client ID is valid, but the API application it belongs to is not configured to accept the grant type Zynk uses. Change the application's Authentication Method in HaloPSA to 'Username & Password', as described in Setting up an API application in HaloPSA.