Home Nodes HaloITSM

HaloITSM

Bring HaloITSM into your Flowgear Workflows to create, update, and query ITSM data (tickets, changes, assets, service catalog, SLAs, approvals) using simple, ready-made operations. The Node surfaces Halo's REST endpoints as easy-to-run Samples, handles OAuth automatically, and presents clear, flattened error messages so you can troubleshoot fast.

Revision History

1.0.0.0 Initial release

Properties

Connection

Type: Connection Input
The Connection Property, which defines your HaloITSM credentials for authentication.

InstanceUrl
Type: String Input
Your Halo tenant URL, e.g. https://yourtenant.haloitsm.com.

ClientId
Type: String Input
The Client ID from your HaloITSM OAuth application.

ClientSecret
Type: Secret Input
The Client Secret from your HaloITSM OAuth application.

AccessToken
Type: Secret Input
Filled automatically after you authenticate by "Connecting your Account" (OAuth 2.0).

RefreshToken
Type: Secret Input
Filled automatically after you authenticate by "Connecting your Account" (OAuth 2.0).

OperationId

Type: String Static
Internal ID of the selected API sample. Selecting a sample populates this for you, along with Request, Response, and relevant parameters if available.

Description

Type: String Static
Short description of the selected sample operation.

Request

Type: JSON Input
Raw JSON request body. Only required for operations that accept a body (e.g. create or update).

Response

Type: JSON Output
Raw JSON response returned by HaloITSMs.

Using the Node

There is a prerequisite of having a HaloITSM tenant and admin permission to create an API application (OAuth client) in Halo.

1. Create a OAuth Client in HaloITSM

  1. Navigate to "Configuration → Integrations → HaloITSM API → View Applications".
  2. Click "+ New" to create a new OAuth Client specifically for your Flowgear Node.
  3. Give your application a clear name that you can associate with Flowgear. Set Active ✓.
  4. Set Authentication Mode to Authorisation Code (Native Application).
  5. Under Client Secret, choose Use a client secret for the token request and store your ClientSecret safely.
  6. Set Login Redirect URLs to the following:
    • [https://app.flowgear.net/r/auth]
    • [https://applegacy.flowgear.net/r/auth]
    • [https://appnext.flowgear.net/r/auth]
  7. Set your Branding, likely to your organisation's name.
  8. Ensure that both Allow Agent Logins ✓ and Allow End-User Logins ✓ are checked.
  9. Go to the "Permissions" at the top, and ensure all:standard is selected.
  10. Save your new OAuth Client.

3. Create the Connection

  1. In the Flowgear Console, click Connections.
  2. Add a new Connection of type HaloITSM.
  3. Enter your InstanceUrl that is associated with your HaloITSM tenant.
  4. Paste the Client ID and Client Secret from your HaloITSM OAuth client from Step 1.
  5. Click Connect your Account.
  6. You will be redirected to a HaloITSM login page using its authorisation URL. Sign in and grant the application access.
  7. Save your Connection.

After you authorise the application, HaloITSM will redirect you back to Flowgear with an authorisation code. The platform automatically completes the OAuth 2.0 handshake by exchanging the code for an AccessToken and RefreshToken, which are securely stored within the Connection.

4. Test your Connection

  1. Click Test on the Connection.
  2. Flowgear will attempt a test API call to a generic HaloITSM endpoint to ensure your credentials are valid.

If the test is successful (✓), your credentials are valid.
If it fails (✗), the test will return an error message, and you may need to re-authorise the Connection. If this problem persists, please contact support for assistance.

Remarks

  • When Halo returns JSON error payloads (sometimes with nested arrays), the Node flattens them into Key: Value lines to speed up troubleshooting. If Halo returns plain text, you will see that verbatim.
  • Terminology: Faults = Tickets: In HaloITSM's terminology, you may often see Faults where the UI and REST API use Tickets. They refer to the same record type.

FAQ

Does this Node support HaloPSA or HaloCRM endpoints?

No. This Node has been filtered to intentionally target only the ITSM scope. If an ITSM endpoint you need is missing, please contact support to let us know! If you would like a connector that exposes PSA or CRM endpoints, please contact support to let us know!

Do I need to paste in my HaloITSM Authorisation Server URL?

No. Enter your InstanceUrl, and the Node will automatically fetch and discover your set Authorisation Server and Tenant Identifier for you during Connect your Account.

See Also