• Skip to primary navigation
  • Skip to main content
  • Skip to footer
  • Skip to custom navigation

HaloITSM

  • Features
  • Solutions
    • By Sector
      • Public Sector

        Reduce overheads and deliver an intuitive experience for your users.

      • Education

        Deliver an exceptional service experience to students, faculty and staff.

      • Financial Services

        Deliver secure, auditable IT Service Management throughout the organisation.

      • Healthcare

        Centralise and streamline your processes.

      • All Sectors →
    • By Use
      • IT Service Management

        Empower your IT team to deliver rapid, efficient ITIL-aligned service.

      • HR Service Management

        Automate, connect and improve your HR service delivery.

      • Facilities Service Management

        Manage your Facilities department with our all-in-one software for resource booking, maintenance, asset management and much more.

      • Enterprise Service Management

        Extend service management throughout the organisation.

      • Service Providers

        Manage your MSP business with our all-in-one platform and transform how you deliver services to customers.

    • Resources
      • Compare ITSM Tools
      • Integrations
  • Case Studies
  • Pricing
  • Contact Us
  • Start trial
  • Schedule a demo

HaloITSM Guides

Documentation to assist with the setup and configuration of the HaloITSM platform

Guides > Connecting Through the API

Connecting Through the API


Connecting to our API could not be simpler. Building your own integration with Halo is all explained in our API documentation. 


We allow the exporting and importing of a lot of your data in JavaScript Object Notation (JSON) format.


Importing Data


To authorise any connection to your Web-App through the API you must register the application, this is done through the integrations tab of the configuration and navigating to the Halo API.

Authentication


This is fully explained in the aformentioned API documentation and will allow your program to have continued access whilst the integration whilst the integration is active in Halo.


Resources and Data


By default, the resource server is available at *your Halo Web Application url*"/api". Each resource then has it's own endpoint, e.g tickets are available at *your NetHelpDesk Web Applicaiton url*"/api/tickets". Endpoints accept the HTTP GET, POST and DELETE methods depending on the resource that you are accessing.


GET - will return a dataset depending on the parameters in the Request.

POST - will accept an array of objects to add or update. Not all fields are required, only those that need to be updated and the ID field.

DELETE - require an ID and will remove the resource with that ID.


Each resource and method is protected by a minimum authentication level.

No Authentication - can access without a token
User - can access as a Halo end user
Agent - can access as a Halo agent
Admin - can only access as a Halo administrator

Resources may be protected further by permissions depending on your Halo configuration.



Common issues


Your program will not receive a grant token:

  • This can often mean that your program does not have access to a valid or up to date SSL Library. Current ones can be downloaded here. These should be placed in the working directory for the program.
  • Somewhere in the input of data a spelling mistake was made.


Popular Guides

  • Asset Import - CSV/XLS/Spreadsheet Method
  • Call Management in Halo
  • Creating Agents and Editing Agent Details
  • Departments, Teams and Roles
  • Importing Data
  • Multiple New Portals with different branding for one customer [Hosted]
  • Organisation Basics
  • Organising Teams of Agents
  • Step-by-Step Configuration Walk Through
  • Suppliers
  • Syncing Exchange Calendars

Footer

Company

  • Contact Us
  • Careers
  • Channel Partners
  • Technology Partners
  • Global Impact
  • Referral Program

HaloITSM

  • Features
  • Integrations
  • Mobile Apps
  • Pricing
  • Onboarding Process
  • Blog
  • Roadmap
  • Guides

Key Features

  • Incident Management
  • Problem Management
  • Change Control
  • Configuration Management
  • ITIL Service Catalogue
  • Knowledge Management

Compare ITSM

  • ServiceNow Alternative
  • FreshService Alternative
  • TOPdesk Alternative
  • Cherwell Alternative
  • Axios Alternative
  • Hornbill Alternative
  • Ivanti Alternative
  • ManageEngine Alternative
  • Spiceworks Alternative

Social

  • Terms and Conditions
  • Privacy Policy
  • Security
  • GDPR