1. foundU
  2. Integrations & Partners
  3. foundU Integration Centre

Integration Centre

Avatar
foundU

Bring all-in-one to the next level!

Unlock the power of seamless data sharing with foundU's Integration Centre. Our all-in-one workforce management solution offers effortless integration with external systems, eliminating the need for manual data transfers.

foundU offers 2 ways to integrate by:

  • Connecting your platform from an ever-growing list of Partner Integrations. 
  • Building your own integration using the API. This can be either a:
    • Custom Integration -  For customers to build their own integrations in their platforms. 
    • Partner Integration - For our new partners to build their integrations using a sandbox. 

This article will cover:

  • Understanding Integrations
  • foundU's Partner Integrations
  • Key information before you start building an integration
  • Creating a Custom Integration
  • Creating a Partner Integration
  • API Documentation

  foundU prides itself on our list of Partner Integrations. Check out the list here, to see if any are the right fit for your business. 

Using Partner Integrations

Understanding Integrations

Integrations are a valued feature that links together different software applications. This allows the  2 applications to share data automatically without the need to export and import data manually.

Some types of applications you may want to integrate with foundU include:

    • Recruitment & Applicant Tracking systems
    • HR software
    • Learning Management systems (LMS)
    • Sales data
    • Accounting software

But why integrate?

Integrating has a wide range of key benefits, such as automating the movement of data between software applications, which can help streamline your processes and remove human error. Some additional benefits include:

    • Saving time with day-to-day tasks
    • Heavily reduces the manual entry of data
    • Maintaining data accuracy
    • Allows software systems to capitalise off of each other's data stores
    • Reduces repetitive reoccurring tasks


Integration Types

foundU offers 2 ways to integrate,  providing customisable solutions to suit your specific business needs; these are:

    • Using our Partner Integrations - connect your platform to an ever-expanding list of partner applications.

      By doing so, you are establishing a connection with a partner that has integrated with foundU. There is no need to build your own integration.
    • Building your own integration - your developers can use the API to create their own integration with foundU.
Partner Integrations 

foundU's Partner Integrations are pre-built software integrations that have been developed and tested for seamless compatibility, allowing you to easily connect them with your platform. 

How to connect a Partner Integration:

  1. Navigate to the main menu > Integrations > Integration Centre.
  2. Using the menu on the left, you can narrow your search by selecting the relevant category.
    • Benefits
    • Hospitality
    • People (HR)
    • Recruitment
    • Superannuation
    • Training
  3. Once you have found your desired integration select Connect.
  4. Follow the instructions provided (depending on the application). Once connected to the Integration Centre, you'll see a green Connected status.

  foundU prides itself on our ever-expanding list of Partner Integrations. Check out the list here, to see if any are the right fit for your business. 

Can't find your application in the list? Let us know! Select this link to complete and add your idea. 

Building an Integration

Before you start

There are two approaches to building an integration, depending on whether you are a customer seeking to integrate with your own platform or a new integration partner looking to build an integration for multiple platforms.

These are referred to as:

    • Custom Integration -  For customers to build their own integrations in their platforms. 
    • Partner Integration - For our new partners to build their integrations using a sandbox. 

To start building your own integrations, please refer to the section below for your specific integration type. 

Key foundU Terminology

Since your developers may be new to our platform, we want to provide them with a list of common terminology used in our system. This will help them get familiar with the language and concepts specific to foundU.

    • Operation - Operations maintain a rates book for all necessary positions, serving as the first level of financial costing. Operations can be used as venues (direct employers), customers (labour hire) or clients (NDIS), however, this is depending on the setup.
    • Position - Is the combination of award rules and pay rates. Once applied to employees they are used for rostering and processing pay. 
    • Position Group - It is a rostering tool that groups multiple positions together, allowing them to be displayed on the roster with a custom name.
    • Location - Is the link between an employee, operation, and the roster(s) they work against. Locations are limited per state. 
    • Cost Code / Purchase Order - Codes created to break down labour costs, these can be done per employee, per shift and per day. This is the second level of financial costing. 
    • Time Off - The overall term used for managing both availability and leave requests. 
Building a Custom Integration

Building a Custom Integration is the process by which our customers can create their own integrations between their preferred applications and add them to their platform. When building a Custom Integration, there are a few key considerations: 

    • Custom Integrations are created in your platform.
    • Your developers build the integrations. 
    • You will need to give your developers platform access.

  Contact us: Before getting started with your integration, we advise scheduling a meeting with our API Team, to discuss the scope of the integration you are looking to achieve.  

Getting started

To begin your integration, we have provided the essential steps for accessing a Custom Integration:

  1. An Admin User with sufficient permissions can create the integration key.
  2. Exchange the integration key for an OAuth Bearer Token.
  3. Use the access token to access the API.
  4. Use the refresh token and client credentials to get new access tokens when they expire.

 

Creating and updating developer access

After meeting with our API Team, the next step will be to request API access for your developers and create an API key.

To create developer access and send an API key:

  1. Navigate to the main menu > Integrations > Integration Centre.
  2. Select the Make a custom integration button.
  3. Select the relevant Permissions and then Continue.
     These are the areas of data that can be accessed and integrated.
    • E.g. Without the people permission, you won’t be able to use employee information.
  4. From the review page, add the following details:
    • Integration Name - The name of the application you are connecting to.
    • Integration Description - Describe the integration. 
    • This integration will be able to - Review the permissions. 
    • Email - Your developer's email address. An email with the API Key and Documentation will be sent upon workflow completion. 
  5. Select Complete Integration.

Once you have granted your developer access to your platform, you can modify their search restrictions and permissions at any time.

How to update a developer's permissions:

  1. Navigate to the main menu > Integrations > Integration Centre.
  2. In the Your Integrations section, locate the required Custom Integration. 
  3. Select the ellipsis, and then choose from the following:
    • Permissions
    • Search Restrictions 
  4. Edit any relevant permissions or search restrictions and then select Update to save.
     



Custom Integration Guide

One of the most useful tools for building integration is accessing the correct guide, as it will highlight the initial steps for creating an authorisation key and resetting your token.

To access the Custom Integration guide: 

  1. Navigate to the main menu > Integrations > Integration Centre.
  2. From the left menu, you can select the Getting Started category (default).

  3. Select Create Custom Integration. This document includes:
    • Provides you with instructions on how to access and refresh your token. 
    • Includes postman link.
    • It can be downloaded as PDF.
       

 

What happens next?

Your request for integration will be reviewed and approved by foundU.

Once approved, you will be emailed, and on the main integrations page, the status will also change from ‘Uninitialised’ to ‘Connected’ when approved.

Building a Partner Integration

Building a Partner Integration involves the process by which our new partners can create a permanent integration with foundU using a sandbox. Once completed, the integration is added to the list of Partner Integrations where customers can connect.

When building a Custom Integration, there are a few key considerations: 

    • Partner Integrations are created in a sandbox which we will provide. 
    • Our partner's developers are responsible for building the integrations.

  Contact us: Before getting started with your integration, we advise scheduling a meeting with our API Team, to discuss the scope of the integration you are looking to achieve.  

 

Getting started

To begin your integration, we have provided the essential steps for accessing a Custom Integration:

  1. Apply for a sandbox portal and auth_key.
  2. Create your integration.
  3. Get your integration reviewed with our API support team.
  4. Once we approve your integration for general use, we'll unlock it for all customers.

 

Developer access

After meeting with our API team, we will provide your developers with admin access to a sandbox platform. This platform will contain fictional employee data to help you test your integration and access to the API code.

For further information on foundU's API, please refer to the API Documentation section below.

 

Partner Integration Guide

One of the most useful tools for building integration is accessing the correct guide, as it will highlight the initial steps for creating an integration request and resetting your token.

To access the Custom Integration guide: 

  1. Navigate to the main menu > Integrations > Integration Centre.
  2. From the left menu, you can select the Getting Started category (default).

  3. Select Create Partner Integration. This document includes:
    • Provides you with instructions on how to access and refresh your token. 
    • Includes postman link.
    • It can be downloaded as PDF.

What happens next?

Once you have completed the integration, submit it for review and approval by our API Team. Our team will carefully assess your integration, and upon approval, it will be unlocked for customer use, allowing you to offer your service to our customers. 

Accessing API Documentation

An API is an Application Programming Interface, a software intermediary that allows 2 software applications to talk to each other. A program can be written to interact with another program.  

Use cases:

    • Synchronising data about employees into foundU from another system.

    • Some data for BI reporting (we are working towards more exports for BI data in the near future).

    • Synchronising data around rosters and clocking in/out with another system.

  Please note: When considering building a Custom Integration, it will be built by your developers.

Give your developer access to the API Documentation via the Integration Centre within your foundU platform. API support is also available upon request.

Some of the endpoints are currently supported:

    • Employee Details
    • Payroll Ledger Map
    • Cost Code
    • Tag Groups
    • Rosters
    • Shift Data
    • Office Codes
    • Position Information
    • Clock Information
    • Compliances (Qualifications / Licences)

  If you wish to provide the API documentation to an external third party without granting platform access, it can be viewed here.

If you require your API team to see your platform's specific information, this will include platform name and logos please see the instructions below. 

How to access the API Documentation:

  1. Navigate to the main menu > Integrations > Integration Centre.
  2. From the left menu, you can select the Getting Started category (default).
  3. In this category, you can select API Documents. 
  4. From the API Document page, on the left-hand side, select the relevant heading for information on all endpoints for that heading. 
  5. You can send the URL to your API team. 
    • For example,  https://{your platform's subdomain}.foundu.com.au/api/reference 

  Hot tip: If you are logged into your platform while viewing the API Documentation, you will be able to see that each section includes a list of related permissions required for access. However, if you are viewing this documentation externally from the platform, the permissions list will not be available.

You can access the API documentation and share it with your developer to get them started. For the next steps, please refer to the Building a Custom Integration or Building a Partner Integration sections above. 

  Hot tip: You can also locate our Terms & Conditions and information about data security in the Integration Centre found via the main menu > Integrations > Integration Centre.

  Contact us: If you require support or assistance using the API, please contact our API team via email. 

Articles in this section