Team planning a system integration with Hire It Out

HIOAPI module

Connect your systems directly to Hire It Out

Everything you need to get data into and out of HIO: a documented API, event-driven webhooks and scheduled report exports.

Why connect

Stop re-keying. Start connecting.

Your systems and HIO, working from the same data.

Without an API

  • Staff re-key data between your systems and HIO
  • Reports are exported and sent around by hand
  • Other systems learn about changes late, or never
  • Every job is raised and scheduled from the HIO screen

With HIOAPI

  • Your systems read and write HIO data directly
  • Reports land in a folder or inbox on a schedule
  • HIO notifies your systems the moment something happens
  • Jobs are created and scheduled without opening HIO

Best suited to businesses building their own systems that interact directly with HIO, and those that need consistent data retrieval for analytics.

Overview

Three ways to move data in and out of HIO

One package. Each component has its own purpose and its own trigger.

HIOAPI

Lets your external systems retrieve HIO data and perform complex actions like job creation and scheduling, independently of the HIO GUI. Triggered by a request from your system.

Webhooks

Lets HIO call your own systems when specific actions happen in HIO, such as a job being created or updated. Triggered by an action performed in HIO.

Scheduled Report Exports

Automatic CSV exports of report data, sent by email or saved to a location you specify. Triggered by a schedule based on rules you configure.

HIOAPI

Read and write HIO data, without the GUI

Your systems ask. HIOAPI answers.

HIOAPI sits and waits for requests from your external systems, processes them and sends the results straight back.

  • Retrieve HIO data on demand
  • Create and schedule jobs from your own systems
  • Works completely independently of the HIO screen
  • Filter and page results with simple query parameters

Resources available (sample)

GET

/api/categories

GET · POST

/api/companies

GET · POST

/api/company-contacts

GET · POST

/api/company-documents

Plus every other resource in your Swagger documentation.

Example request and response

GET /api/categories

?pageNumber=1&pageSize=50

200 OK · application/json

[ {

  "categoryId": 1,

  "code": "PROD",

  "name": "Product",

  "type": "PRODUCT"

}, ... ]

HIOAPI

Documented, testable and plain JSON

Try every call in your browser before you write a line of code.

  • Interactive Swagger documentation: see every resource available to you, then use Try it out to run a request.
  • Filter and page your results: query parameters narrow a request down, and pageNumber and pageSize control how much comes back.
  • Standard JSON responses: a successful call returns a JSON body that your systems can use straight away.

HIOAPI

Controlled access. Fully traceable.

You choose the credentials. HIO records who made every change.

  • You set the credentials: external systems connect using Basic Authentication, with the username and password you specify.
  • A dedicated HIOAPI user: changes that alter the database, such as scheduling a job, are recorded against the HIO user you nominate.
  • Easy to audit: create a new user just for HIOAPI, so you can always see which changes were made through the API.

Tools > Configuration > HIOAPI

General credentials

Usernamehioapi
Password•••••••••

General defaults

HIOAPI user(HIOAPI)

Getting started

Up and running in four steps

From configuration to your first successful call.

  1. Step 1

    Open HIOAPI configuration

    In HIO, go to Tools > Configuration and click the HIOAPI tab.

  2. Step 2

    Set your credentials

    Add a username and password, and nominate an HIO user as your HIOAPI user.

  3. Step 3

    Test a request

    Open your Swagger address, expand Category, click Try it out, then Execute.

  4. Step 4

    See your data

    Sign in with your credentials and a JSON list of your Categories comes back.

Once the test works, you’re ready to make requests from your own systems.

Example rule

When

A Job Task’s status changes to Scheduled

Only if

The task is Install and the category is Fencing

Then

HIO calls myservice.com.au/api/scheduled

Webhooks

Let HIO tell your systems what happened

Event-driven: when something changes in HIO, your system hears about it.

An action happens in HIO, the webhook fires, a request goes to your endpoint and your system returns a result. Set it up in four fields:

  • A type, such as Job Task
  • A condition and parameter, such as Status Changed to Scheduled
  • The URI of your endpoint
  • Optional filters on Task, Category and Product

Webhooks

Rich payloads. Full visibility.

Everything your system needs arrives in a single request.

  • The webhook that fired and the job task behind it
  • Task, product and equipment, with quantities
  • Pricing: cost per metre, discounts and totals
  • Subcontractor instructions, job and group numbers

Track every delivery: Tools > Monitor Queue Log shows each request as NEW, SUCCESS or FAILED.

Example payload (abridged)

"typeDescription": "Job Task",

"conditionDescription": "Status Changed",

"parameterDescription": "Scheduled",

"taskName": "Install Temporary Fencing",

"productCode": "TEMP-FENCE-PANEL",

"calculatedMetres": 60.0,

"total": 525.0,

"jobNo": "T12345678"

Auto Report Exports

Report typeAll Hired + Pending Pickups
Export directoryC:\Reports

Export email to

accounts@examplecompany.com.au

FrequencyEvery 1 week
Next export4:00 AM
Max previous reports10

Auto report exports

Scheduled reports, delivered automatically

Any HIO report as an Excel CSV export, saved to a folder or emailed to your team.

  • Open Reports: from the HIO Start Page, click Reports, then Scheduled Exports at the bottom-left.
  • Pick a report and frequency: choose any report from the left-hand panel, set the type and frequency, then click Add.
  • Save, and you’re done: the report runs automatically at the next scheduled time slot.

Use cases

What you can build with HIOAPI

Example ways to put the three components to work.

Keep customers in step

HIOAPI: create companies, contacts and documents in HIO directly from your CRM, website or customer portal.

Trigger your dispatch

Webhooks: send installs to your field or dispatch system the moment a job task becomes Scheduled.

Power your analytics

Auto exports: receive Excel exports of any report on a schedule, ready for your reporting and BI tools.

Automate job creation

HIOAPI: raise and schedule jobs from your own application, with nobody needing to touch the HIO screen.

Connect your systems to Hire It Out

Talk to the team that built the API about what you want to connect.

Talk To Our Team