# Halo Service Desk

## Connection Requirements

{% stepper %}
{% step %}

### Domain

Your HALO Service Desk domain URL.

{% hint style="info" %}

* **On-Premise:** Your hosted domain (e.g., support.haloservicedesk.com)
* **Cloud:** Your cloud instance domain (e.g., yourcompany.haloservicedesk.com)
  {% endhint %}

You can find your domain in **Config > Integrations > Halo API** under API Details.
{% endstep %}

{% step %}

### Username

The Agent username for authentication. This user must have appropriate permissions to access the required API resources.
{% endstep %}

{% step %}

### Password

The password for the Agent account.
{% endstep %}

{% step %}

### Client ID

The Client ID from your HALO API application registration.

{% hint style="info" %}
How to get your Client ID:

* Navigate to **Config > Integrations > Halo API**
* Register your application or select an existing one
* Set the Authentication Method to **"Username & Password"**
* Copy the Client ID from the application details
  {% endhint %}
  {% endstep %}

{% step %}

### Is Cloud

Select whether you are using a cloud-hosted solution or on-premise installation.
{% endstep %}

{% step %}

### Tenant (Cloud only)

Required only for cloud-hosted solutions.
{% endstep %}

{% step %}

### Proxy (Optional)

Proxy URL (optional).
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Required Permissions

The Agent account must have API permissions configured in HALO. The scope should include:

* Access to Assets API (for device inventory)
* Access to Users API (for user information)
* Set scope to **"all"** if unsure of specific requirements
  {% endhint %}

{% hint style="warning" %}
Attention

Please perform a connection test to ensure there is a valid connection to the HALO Service Desk host. When the discovery operation is finalized you will be able to see the details on the Assets page.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.octoxlabs.com/adapters/adapters/halo-service-desk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.