> For the complete documentation index, see [llms.txt](https://docs.cow.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cow.tech/using-cow/navigation/integrations/halopsa.md).

# HaloPSA

Instructions on connecting and configuring Halo.

## Introduction

Integrating HaloPSA with COW allows you to seamlessly synchronise your device and warranty data, ensuring that your information is up-to-date and accurately managed. This guide will walk you through the steps required to set up and configure your HaloPSA integration.

### Prerequisites

Before you begin the integration process, ensure you have the following information ready:

* **HaloPSA URL**: Enter the URL of your HaloPSA instance.
* **HaloPSA Client ID**: Enter the client ID for authentication.
* **HaloPSA Secret**: Enter your API secret securely.

### Setup

{% @storylane/embed subdomain="app" url="<https://app.storylane.io/share/xmyh2w67fya7>" linkValue="xmyh2w67fya7" %}

## Sync Options

After a successful **Test**, the screen opens the **Sync Options** tab and loads the lists below from HaloPSA. Click **Submit** to save them along with your credentials.

| Setting                    | Description                                                                                                                                     |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Select Device Types        | The asset types to sync. Syncing asset types COW does not support can make syncs take longer.                                                   |
| Select Serial Number Field | The HaloPSA field that holds each asset's serial number: `Fields_Serial_Number`, `inventory_number`, `key_field`, `key_field2` or `key_field3`. |
| Enable write back to PSA   | Lets COW write changes back to HaloPSA.                                                                                                         |
| Sync all clients           | Syncs devices for every client. Turn it off to choose clients in **Select Clients** instead.                                                    |

{% hint style="warning" %}
`Fields_Serial_Number` reads the asset's **Serial Number** field, which can make syncs much slower and run into HaloPSA rate limits. Use one of the other fields where you can. With `Fields_Serial_Number`, **Test Report** also needs at least one device type selected.
{% endhint %}

To change the settings later, click the card again. Password and key fields are blank: leave them blank to keep the stored values. If you change the connection details, click **Test** again before you submit. To preview which devices would sync, enter the password and key fields again, then click **Test Report**. See [Test Report](https://docs.cow.tech/using-cow/navigation/integrations.md#test-report). To remove the integration, see [Delete an Integration](https://docs.cow.tech/using-cow/navigation/integrations.md#delete-an-integration).

## Troubleshooting

* **Test fails with "credentials incomplete"**: enter the **HaloPSA URL**, **HaloPSA Client ID** and **HaloPSA Secret**.
* **Test fails with "Connected, but could not retrieve a sample device, device type, and client"**: the API application signed in, but cannot read at least one asset, asset type and client. Check its permissions against [Halo PSA Permissions](https://docs.cow.tech/using-cow/navigation/integrations/halopsa/halo-psa-permissions.md).
* **Sync Options shows an error instead of the lists**: check the credentials on the **Credentials** tab, then open **Sync Options** again to retry.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cow.tech/using-cow/navigation/integrations/halopsa.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
