> For the complete documentation index, see [llms.txt](https://docs.zigiwave.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zigiwave.com/available-systems/halo-itsm.md).

# Halo ITSM

Connect Halo ITSM to ZigiOps. Supported versions, prerequisites, OAuth 2.0 authentication, connected system configuration, ticket type discovery, operations, and filtering.

### What is Halo ITSM integration in ZigiOps?

Halo ITSM (HaloITSM) is an IT service management platform used to manage incidents, problems, changes, service requests, and other ITIL processes.

ZigiOps enables secure, agentless, no-code integration between Halo ITSM and ITSM, DevOps, monitoring, and CRM systems. ZigiOps connects to the Halo ITSM REST API and authenticates with **OAuth 2.0 Client Credentials**.

Halo has one ticket type per ticket category (Incident, Problem, Change Request, and so on), and each ticket type has its own custom field set. ZigiOps therefore discovers **one collection per ticket type**, so every ticket type is exposed with its own fields.

With ZigiOps, you can:

* Get tickets from Halo ITSM per ticket type, with filtering and pagination
* Create and update tickets, including platform fields and custom fields
* Read ticket notes and add new notes to existing tickets
* Read ticket actions (who did what, and when)
* Read ticket attachments, including the binary content, and upload new attachments
* Query users, for example by site
* Integrate without custom scripts or plugins

### Which Halo ITSM versions are supported?

Using a supported version is mandatory.

| Product   | Supported Deployment Types | Supported Versions | API Used                           |
| --------- | -------------------------- | ------------------ | ---------------------------------- |
| Halo ITSM | All                        | All                | Halo ITSM REST API (`{url}/api/…`) |

### Are there any environmental prerequisites for Halo ITSM?

Confirm the prerequisites of the corresponding integration template before continuing further, as some templates may not require all environmental prerequisites.

See the **Related Templates** section at the end of this page.

All requests to Halo ITSM must be authenticated. ZigiOps uses OAuth 2.0 Client Credentials, so you need a **Client ID** and a **Client Secret** from an API application registered in Halo ITSM.

#### How do I get a Client ID and Client Secret in Halo ITSM?

{% stepper %}
{% step %}
**Log in to Halo ITSM**

Log in to your **Halo ITSM** instance.
{% endstep %}

{% step %}
**Navigate to the HaloITSM API settings**

Navigate to **Configuration > Integrations > HaloITSM API**.
{% endstep %}

{% step %}
**Create an application**

Create an **Application** for ZigiOps.
{% endstep %}

{% step %}
**Copy the application credentials**

Copy the **Client ID** and **Client Secret** of the same Application and store them securely. You will need both when you configure the connected system in ZigiOps.
{% endstep %}
{% endstepper %}

ZigiOps uses these credentials to obtain an access token and sends it with every request:

| Header Name   | Header Value           | Header Example                                                      |
| ------------- | ---------------------- | ------------------------------------------------------------------- |
| Authorization | Bearer {access\_token} | `Authorization: Bearer wnbXyVbmTDS9Js3mvDO_UY_J3WN8TcxmRSwBHw2kg_4` |

### How do I connect Halo ITSM to ZigiOps?

#### Halo ITSM - Connected System Configuration

Follow the steps below to add Halo ITSM as a connected system in ZigiOps.

{% stepper %}
{% step %}
**Log in to ZigiOps**

Log in to your **ZigiOps** instance.
{% endstep %}

{% step %}
**Add a Halo ITSM connected system**

Navigate to **Connected Systems > Add New System > Halo ITSM** and configure the following parameters:

**Name** Input a name for the instance.

**URL** Input the URL of your Halo ITSM tenant. Example: `https://yourcompany.haloitsm.com`

**Authentication** Select the authentication type. Default: **OAuth 2.0**.

**Client ID** Input the Client ID of the OAuth application registered in Halo ITSM.

**Client Secret** Input the Client Secret of the same application.
{% endstep %}

{% step %}
**Test the connection**

Review the configuration and test the connection. The connection test queries the Halo ITSM ticket types (`id` and `displayname`).
{% endstep %}

{% step %}
**Save the connected system**

Click **Save** to store the connected system.

Once saved, Halo ITSM becomes available for use in ZigiOps integration templates.
{% endstep %}
{% endstepper %}

#### Halo ITSM system settings reference

| Parameter      | Description                                                                                                           | Type        | Mandatory | Default Value |
| -------------- | --------------------------------------------------------------------------------------------------------------------- | ----------- | --------- | ------------- |
| Name           | Name of the instance                                                                                                  | string      | Yes       | -             |
| URL            | Tenant URL                                                                                                            | URL         | Yes       | -             |
| Authentication | Authentication type                                                                                                   | select-list | Yes       | OAuth 2.0     |
| Client ID      | Unique identifier for the OAuth application registered in Halo, used to authenticate the connector against the tenant | string      | Yes       | -             |
| Client Secret  | Application secret for authentication                                                                                 | string      | Yes       | -             |

### Which Halo ITSM entities does ZigiOps support?

| Entity                                                          | Operations            | Key Fields                                                                                                                                                                                                                                                                   |
| --------------------------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Ticket (one collection per ticket type, for example `incident`) | Query, Create, Update | All local fields, including platform fields such as `summary`, `details`, `status_id`, `priority_id`, `impact`, `urgency`, `category_1`, `site_id`, `last_update`, plus discovered custom fields and `tickettype/id`, `tickettype/name`, `tickettype/guid`, `tickettype/use` |
| Notes (on a ticket)                                             | Query, Create         | `note`, `actiondatecreated`                                                                                                                                                                                                                                                  |
| Actions (on a ticket)                                           | Query                 | `id`, `outcome`, `who`, `note`, `actiondatecreated`                                                                                                                                                                                                                          |
| Attachments (on a ticket)                                       | Query, Create         | `id`, `filename`, `blob` (binary content)                                                                                                                                                                                                                                    |
| User                                                            | Query                 | `id`, `name`, `site_id`                                                                                                                                                                                                                                                      |

### What are the most common Halo ITSM integration use cases?

#### Use case 1: Synchronizing Halo ITSM tickets with other ITSM and DevOps platforms

ZigiOps gets tickets from Halo ITSM per ticket type (for example, incidents) and creates or updates the corresponding records in the connected system. Changes flow back to Halo ITSM through ticket creation and update, keeping both teams aligned.

#### Use case 2: Polling for new and updated tickets

ZigiOps filters Halo ITSM tickets by `last_update` and other fields with comparison operators (`=`, `>`, `>=`, `<`, `<=`). This lets ZigiOps pick up only new or changed tickets on each run.

#### Use case 3: Keeping notes, actions, and attachments in sync

ZigiOps reads ticket notes and actions, adds new notes, and reads and uploads attachments, including binary content. Teams on both sides see the full ticket history without switching tools.

#### Use case 4: Mapping custom fields across systems

Because ZigiOps discovers each ticket type’s custom fields automatically, including fields nested in groups, tenant-specific fields can be mapped to the connected system without manual schema work.

### What integration templates are available for Halo ITSM?

ZigiOps supports Halo ITSM integrations with prebuilt and custom integration templates, depending on the target system and use case.

#### Related Templates

For detailed information about available templates for Halo ITSM integrations, please contact:

**Email:** <support@zigiwave.com>

### Halo ITSM integration FAQ

<details>

<summary>How does ZigiOps authenticate to Halo ITSM?</summary>

ZigiOps uses OAuth 2.0 Client Credentials. You provide the Client ID and Client Secret of an Application created under **Configuration > Integrations > HaloITSM API**, and ZigiOps sends the resulting access token as a Bearer token.

</details>

<details>

<summary>Does ZigiOps support Halo ITSM custom fields?</summary>

Yes. ZigiOps discovers custom fields per ticket type, including fields nested inside groups, and maps them back to Halo’s `customfields[]` array on read and write.

</details>

<details>

<summary>Why does ZigiOps show a separate collection for each Halo ticket type?</summary>

In Halo ITSM, each ticket type (Incident, Problem, Change Request, and so on) has its own custom field set. One collection per ticket type keeps each type’s fields accurate.

</details>

<details>

<summary>Can ZigiOps sync Halo ITSM notes and attachments?</summary>

Yes. ZigiOps reads and creates notes, reads actions, and reads and uploads attachments, including the binary content.

</details>

### Summary

The Halo ITSM integration in ZigiOps provides:

* Secure, agentless, no-code integration with Halo ITSM
* OAuth 2.0 Client Credentials authentication
* Automatic discovery of ticket types and custom fields, with one collection per ticket type
* Read and write support for tickets, notes, and attachments, plus read support for actions and users
* Comparison filtering through `advanced_search` and paginated results


---

# 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.zigiwave.com/available-systems/halo-itsm.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.
