​

Extra information

System documentation: [HaloITSM API Reference]

​

Setting up HTTP Client HaloITSM

​

Steps

• In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select HaloITSM HTTP Client as the prototype of the HTTP Client.
• Fill in the Base URI, Authentication type.
  • Username & Password : Fill in Client ID, Username, Password, and Scopes.
  • Client Credentials : Fill in Client ID, Client Secret, and Scopes.
• Save the Client for use later.

Currently we Support only Username & Password, and Client Credentials for Authentication.

​

Subscribing to Entities from HaloITSM

​

Steps

• Go to Connections -> Incoming and create a new incoming configuration and select HaloITSM Subscriber as the subscriber.
• Select the entity you want to subscribe from HaloITSM .
• Add any request parameters needed to subscribe to the entity (optional).
• You can optionally add a transformer to transform the request parameters into something you need.
• Select the HaloITSM HTTP Client to use.

​

General Concept

We follow HaloITSM documentation on building this connector so you can easily use the connector based on HaloITSM API Reference. Entity It’s the entity you want to subscribe from HaloITSM . Please refer to the entities in Management APIs from HaloITSM API Reference page. Request Parameters These are the parameters you can provide to get the needed entity based on HaloITSM API Reference. Please look at the example below on how to fill the Request Parameters field when Returns a single action object. That’s why we need to define the id property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Returns a single action object. /Actions/AC12 Input Transformer Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. HTTP Client It’s the HTTP Client configuration or prototype you will use to access HaloITSM .

​

Publishing Entity to HaloITSM

​

Steps

• Go to Connections -> Outgoing, create a new outgoing configuration, and select HaloITSM Publisher as the publisher.
• Select the action that you want the publisher to do with the data.
• Select the HaloITSM entity you want the data to be published.
• You can optionally add any query parameters to the request.
• You can also optionally add any transformers to transform the data into anything you need before submitting it to HaloITSM .
• Select the HTTP Client to use.

​

General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. Method Currently, we support Post (HTTP POST method), and Delete (HTTP DELETE method). Entity We support publishing to most HaloITSM endpoints. Please refer to the entities in Management APIs from the HaloITSM API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a new assets. Please select “Post” as the action and “Adds or updates one or more Assets…….” as the entity of the publisher. You can put the payload you want to send to HaloITSM into the payload property in the data. Alumio will send an API request to HaloITSM with URL /Assets HTTP Client It’s the HTTP Client configuration or prototype you will use to access HaloITSM .