HaloITSM
HaloITSM is an IT service management platform that provides comprehensive ticket tracking, incident management, and service desk capabilities. You can bring ticket data from HaloITSM into Brinqa to gain a unified view of your IT operations, thus strengthening your cybersecurity posture.
This document details the information you must provide for the connector to authenticate with HaloITSM and how to obtain that information from HaloITSM. See create a data integration for step-by-step instructions on setting up the integration.
Required connection settings
When setting up a data integration, select HaloITSM from the Connector dropdown. If you cannot find the connector in the dropdown, make sure that you have installed it first. You must provide the following information to authenticate HaloITSM with Brinqa:
-
Server URL: Your organization's HaloITSM API base URL. The default URL format is
https://<servername>/, where<servername>is your organization's HaloITSM server hostname. -
Client ID: The OAuth2 Client ID for the HaloITSM API. This is used along with the Client Secret to authenticate via the OAuth2 client credentials flow.
-
Client Secret: The OAuth2 Client Secret for the HaloITSM API. This value is confidential and should be stored securely.
Additional settings
The HaloITSM connector contains additional options for specific configuration:
- Page size: The maximum number of records to get per API request. The default setting is 100. It is not recommended to go over 100.
- Parallel requests: The maximum number of parallel API requests. The default setting is 4.
- Maximum retries: The maximum number of times that the integration attempts to connect to the HaloITSM API before giving up and reporting a failure. The default setting is 5.
- Include custom fields: Select this option to include custom fields from HaloITSM tickets. The default setting is disabled. When enabled, the connector fetches detailed ticket data to extract custom field values, which may increase sync time.
- Ticket type: Optionally filter tickets by a specific ticket type name (e.g., "Incident", "Service Request"). When set, only tickets matching the specified type are retrieved.
Types of data to retrieve
The HaloITSM connector can retrieve the following types of data from the HaloITSM API:
Table 1: Data retrieved from HaloITSM
| Connector Object | Required | Maps to Data Model |
|---|---|---|
| Ticket | Yes | Not mapped |
The HaloITSM connector does not currently support operation options for the types of data it retrieves.
For detailed steps on how to view the data retrieved from HaloITSM in the Brinqa Platform, see How to view your data.
Attribute mappings
Expand the sections below to view the mappings between the source and the Brinqa data model attributes.
Ticket
Table 2: Ticket attribute mappings
| Source Field Name | SDM Attribute |
|---|---|
ticket.agentId() | AGENT_ID |
ticket.appointmentType() | APPOINTMENT_TYPE |
ticket.attachmentCount() | ATTACHMENT_COUNT |
ticket.category1() | CATEGORY_1 |
ticket.category1Display() | CATEGORY_1_DISPLAY |
ticket.category2() | CATEGORY_2 |
ticket.category2Display() | CATEGORY_2_DISPLAY |
ticket.category3() | CATEGORY_3 |
ticket.category3Display() | CATEGORY_3_DISPLAY |
ticket.category4() | CATEGORY_4 |
ticket.category4Display() | CATEGORY_4_DISPLAY |
ticket.childCount() | CHILD_COUNT |
ticket.clientId() | CLIENT_ID |
ticket.clientName() | CLIENT_NAME |
ticket.cost() | COST |
ticket.createdFromAutomationStdId() | CREATED_FROM_AUTOMATION_STD_ID |
ticket.dateOccurred() | SOURCE_CREATED_DATE |
ticket.deadlineDate() | DEADLINE_DATE |
ticket.departmentId() | DEPARTMENT_ID |
ticket.details() | DESCRIPTION |
ticket.emailToList() | EMAIL_TO_LIST |
ticket.endUserStatus() | END_USER_STATUS |
ticket.estimate() | ESTIMATE |
ticket.estimateDays() | ESTIMATE_DAYS |
ticket.excludeFromSla() | EXCLUDE_FROM_SLA |
ticket.fixByDate() | FIX_BY_DATE |
ticket.flagged() | FLAGGED |
ticket.guid() | GUID |
ticket.id() | UID |
ticket.idSummary() | ID_SUMMARY |
ticket.impact() | IMPACT |
ticket.impactLevel() | IMPACT_LEVEL |
ticket.inactive() | INACTIVE |
ticket.invoiceSeperatelyOverride() | INVOICE_SEPERATELY_OVERRIDE |
ticket.isImportantContact() | IS_IMPORTANT_CONTACT |
ticket.isVip() | IS_VIP |
ticket.itilRequestTypeId() | ITIL_REQUEST_TYPE_ID |
ticket.lastActionDate() | LAST_ACTION_DATE |
ticket.lastIncomingEmail() | LAST_INCOMING_EMAIL |
ticket.lastUpdate() | SOURCE_LAST_MODIFIED |
ticket.matchedKbId() | MATCHED_KB_ID |
ticket.maximumRestrictedPriority() | MAXIMUM_RESTRICTED_PRIORITY |
ticket.mergedIntoId() | MERGED_INTO_ID |
ticket.notUsefulCount() | NOT_USEFUL_COUNT |
ticket.onHold() | ON_HOLD |
ticket.openSearchScore() | OPEN_SEARCH_SCORE |
ticket.oppCompanyName() | OPP_COMPANY_NAME |
ticket.oppValueAdjusted() | OPP_VALUE_ADJUSTED |
ticket.organisationId() | ORGANISATION_ID |
ticket.pipelineStageId() | PIPELINE_STAGE_ID |
ticket.priorityId() | PRIORITY_ID |
ticket.productId() | PRODUCT_ID |
ticket.purchaseOrderNumber() | PURCHASE_ORDER_NUMBER |
ticket.quantity() | QUANTITY |
ticket.read() | READ |
ticket.release2Id() | RELEASE2_ID |
ticket.release3Id() | RELEASE3_ID |
ticket.releaseId() | RELEASE_ID |
ticket.releaseImportant() | RELEASE_IMPORTANT |
ticket.releaseNoteGroupId() | RELEASE_NOTE_GROUP_ID |
ticket.reportedBy() | REPORTED_BY |
ticket.respondByDate() | RESPOND_BY_DATE |
ticket.reviewed() | REVIEWED |
ticket.sectionTimezone() | SECTION_TIMEZONE |
ticket.serviceStatusNote() | SERVICE_STATUS_NOTE |
ticket.siteId() | SITE_ID |
ticket.siteName() | SITE_NAME |
ticket.siteTimezone() | SITE_TIMEZONE |
ticket.slaHoldTime() | SLA_HOLD_TIME |
ticket.slaId() | SLA_ID |
ticket.source() | SOURCE |
ticket.startTime() | START_TIME |
ticket.startTimeSlot() | START_TIME_SLOT |
ticket.statusId() | STATUS |
ticket.statusId() | STATUS_ID |
ticket.summary() | NAME |
ticket.supplierStatus() | SUPPLIER_STATUS |
ticket.table() | TABLE |
ticket.targetDate() | TARGET_DATE |
ticket.targetTime() | TARGET_TIME |
ticket.targetTimeSlot() | TARGET_TIME_SLOT |
ticket.team() | TEAM |
ticket.teamId() | TEAM_ID |
ticket.ticketAge() | TICKET_AGE |
ticket.ticketTags() | TICKET_TAGS |
ticket.ticketTypeId() | TICKET_TYPE_ID |
ticket.updateServiceStatus() | UPDATE_SERVICE_STATUS |
ticket.urgency() | URGENCY |
ticket.use() | USE |
ticket.usefulCount() | USEFUL_COUNT |
ticket.userDef1() | USER_DEF_1 |
ticket.userDef2() | USER_DEF_2 |
ticket.userDef3() | USER_DEF_3 |
ticket.userDef4() | USER_DEF_4 |
ticket.userDef5() | USER_DEF_5 |
ticket.userEmail() | USER_EMAIL |
ticket.userId() | USER_ID |
ticket.userName() | USER_NAME |
ticket.workflowId() | WORKFLOW_ID |
ticket.workflowSeq() | WORKFLOW_SEQ |
ticket.workflowStep() | WORKFLOW_STEP |
APIs
The HaloITSM connector uses the HaloITSM API. Specifically, it uses the following endpoints:
Table 3: HaloITSM API endpoints
| Connector Object | API Endpoint |
|---|---|
| Ticket | GET /api/tickets |
GET /api/tickets/{id} | |
GET /api/status | |
GET /api/tickettype |
Changelog
The HaloITSM connector has undergone the following changes:
This connector is part of a bundled release with other connectors from the same vendor. If a version shows "No change", it means that the connector version was updated for consistency as part of the bundle, but no functional changes were made to this specific connector. You can update to or skip this version without affecting your existing configuration.
Table 4: HaloITSM connector changelog
| Version | Description | Date Published |
|---|---|---|
| 3.0.0 | Initial Integration+ release. | April 17th, 2026 |