Skip to main content

HaloITSM Data Connector

The HaloITSM Data Connector syncs ticket data from your Halo instance via the HaloITSM REST API.

By default, the connector pulls all ticket types into a single tickets table keyed by Halo's id field. To split by ticket type, for example to separate incident and service_request tables, configure the optional ticket_types map.

Authentication

Halo uses an OAuth 2.0 client-credentials flow against its tenant API. Generate an API client in your Halo tenant and provide the following to your BigPanda account team:

  • Tenant name used in the OAuth token request and as the value for the connector's tenant configuration field.

  • Client ID of the dedicated BigPanda integration application.

  • Client Secret of the same application.

The connector exchanges these credentials at POST {base_url}/auth/token?tenant={tenant} and refreshes tokens automatically.

Sync preferences

Provide the following information about your sync preferences to BigPanda:

Required Configuration 

Option

Description

Mode

Determine whether you’d like to set up an incremental or historical sync. 

Most organizations will use both modes. See the Streaming Modes section for more information.

tenant 

Your HaloITSM tenant name.

Connector configuration

Option

Default

Description

start_date 

—

Earliest ticket date to ingest, YYYY-MM-DD.

end_date 

—

Latest ticket date to ingest, YYYY-MM-DD. Used for historical syncs only.

ticket_types 

all types in tickets

Map of destination-table-name, {type_id, fields}. Omit for the default single-table behavior.

page_size 

100 

Records per API page.

rate_limit 

30 

API requests per minute.

request_timeout 

60 

HTTP request timeout, in seconds.

Per-type configuration (optional)

Set ticket_types to a map of destination-table-name when you want each Halo ticket type to land in its own table:

Option

Description

type_id 

Halo ticket type ID. For example, 1 for Incident.

fields 

A list of fields to fetch. id and last_update are always included. Omit to fetch all fields.

Each entry produces a separate ingestion resource and destination table (for example, incident, service_request). The connector calls Halo's API once per configured type.

Default: Single tickets table

If you do not configure ticket_types, the connector pulls every ticket the BigPanda service account can read into a single tickets table. Each row carries Halo's id and the ticket fields exposed by the API. This is the simplest setup and works for most BigPanda use cases.

In this section: