Explore

Boon Integration Overview

Last updated March 2025

Below is a basic overview of Boon's integration functionality. If you have a question that is not answered below or in the

FAQ⁠

, please contact your sales associate or

sales@goboon.co⁠

⁠

1. Introduction

Overview of Boon’s ATS Integration Capabilities

Boon provides seamless integrations with various Applicant Tracking Systems (ATS) to streamline referral-based hiring processes for enterprises. Our integration capabilities ensure that job listings, applications, candidate referrals, and hiring statuses are synchronized efficiently, reducing recruiters' manual work and enhancing referral program transparency.

By integrating directly with an ATS, Boon ensures:

Automated Job Synchronization: Job openings are fetched from the ATS and made available within Boon for referrals.

Candidate Application Processing: Applications submitted through Boon are either redirected to the ATS or posted via API.

Referral Attribution & Tracking: Boon keeps track of referrals, ensuring visibility into their hiring progress and also marks the candidate source directly on the ATS for accurate reporting.

Status Updates & Workflow Automation: Hiring stages and updates from the ATS reflect within Boon.

Security & Compliance: The integration follows GDPR guidelines, with encrypted API communication and OAuth authentication mechanisms.

⁠

View Data Flow Chart

⁠

2. Integration Methods & Architecture

2.1 API-Based Integrations

Boon integrates directly with ATS platforms via secure APIs, allowing seamless data exchange and automation. This integration ensures that job postings, applications, candidate referrals, and hiring statuses are accurately synced, providing a fully automated and efficient recruitment process.

Note: Boon also integrates with ATS platforms via middleware solutions like Merge. These act as intermediary layers that enable multiple ATS integrations under a single API framework while maintaining the same API-based integration principles.

2.2 Integration via Reports Import

For ATS platforms that do not provide a direct API or have limited API functionalities, Boon supports integration via reports import. This method ensures the same level of automation and efficiency as API-based integrations, provided that all required fields are correctly exported from the ATS. The process includes:

Automated Scheduled Report Export: The ATS exports Jobs and Candidates data on a scheduled basis, ensuring up-to-date information is sent to Boon. Data detailed here: Boon ATS Integration Capabilities

Secure Delivery Methods:

Reports can be sent to a dedicated email address generated for each customer.

Alternatively, reports can be placed in an SFTP location, which Boon securely retrieves and processes.

Automated Import & Processing:

Boon automatically captures and parses the received data.

Updates job listings, application statuses, and referral data accordingly.

Full Automation Assurance: If all required fields are correctly exported, clients experience the same level of automation and service as API-based integrations, ensuring seamless synchronization between Boon and the ATS.

2.3 Data Synchronization & Flow

Data exchange between Boon and the ATS occurs through structured API calls and scheduled syncs:

Job Listings Sync:

ATS → Boon: Job postings are fetched from the ATS and displayed within Boon.

Application Data Sync:

Boon → ATS: If candidates apply through Boon, applications are pushed to the ATS.

ATS → Boon: If candidates apply via ATS via a referral generated on Boon, their status is retrieved and updated in Boon.

Referral Tracking & Status Updates:

Boon → ATS: Referral details are logged within Boon and the candidate/application Source is marked as “Boon” in the ATS.

ATS → Boon: Updates on Candidate application progress are reflected in Boon

⁠

3. Integration Setup

Boon offers two primary methods for integrating with an ATS: API-based integration and scheduled report imports. The setup process varies depending on the method chosen.

3.1 API-Based Integration Setup

The API-based integration is simple and self-service, requiring minimal manual effort:

The user accesses the integration link within Boon’s platform.

They follow the guided setup process, which connects Boon to their ATS.

Each ATS has a dedicated setup guide, which can be accessed in the documentation

Once connected, job listings, applications, and candidate referral tracking begin automatically based on sync schedules.

Job Openings data via the API :

Field Name

Notes

Job External ID*

Used for tracking across systems

Job title*

Location

If not available, automatically default to Organization’s HQ location

Description

Application URL

Required If the desired flow is for the candidates to apply directly on the ATS

Experience level

Entry & Junior Level, Associate, Mid-Senior Level, Director Level, Executive, Not Applicable

Urgency

Normal, Urgent

Work type / Employment Type

Full-time, Part-time, Contract, Temporary, Cofounder, Volunteer, Internship

Workplace type

On-site, Hybrid, Remote

Salary range - Low

Currency options are available and will be applied to both values.

Salary range - High

Currency options are available and will be applied to both values.

Owner

Default to the org Super Admin unless specified via a custom field from the ATS

Hiring Managers

Left Empty unless specified via a custom field from the ATS

Visibility

Team Only, Everyone

Publish status

Draft, Archive, Publish

Custom fields

Boon can collect and store custom field data as needed.

There are no rows in this table

⁠

Candidate/Application data synced via the API

Field Name

Notes

Candidate Name

Candidate Email Address

Phone Number

If supported by the ATS via API

Resume

If supported by the ATS via API

Hiring Stage

Mapped to the correct stage on the ATS

Source

Mapped to Boon

There are no rows in this table

⁠

3.2 Reports Import Integration Setup

For ATS platforms that do not support API integration, users must configure a scheduled export of job and candidate data. The required setup includes:

a. Exporting Job Listings Data

Customers must generate a scheduled report from the ATS containing the following fields for job synchronization:

Field name

Input Requirements

Notes

External Job id / Requisition id *

Alpha numeric

Job title*

Text

Job location zip code

Numeric

If not available, automatically default to Organization’s HQ location

Location text

Text

If not available, automatically default to Organization’s HQ location

Description *

Rich text

Work type *

Full-time / Part-time / Hourly / Contract

Workplace type

Remote / Hybrid / On-Site

Sharing scope *

Everyone / Team Only / Marketplace Only / Hidden

Everyone: Members of your referral community, Boon’s referral community, and the general public can view the opening.

Team only: Only referral community members and those that they refer an view the opening.

Marketplace only: Only members of Boon’s referral community and those that they refer can view the opening.

Hidden: Cannot be viewed by anyone unless an admin shares the link to the role.

Publish *

Publish / Draft / Archive

Application URL *

URL

The link where candidates would be applying on the job board

Hiring manager

Email address

Email address of hiring manager

Skills

Comma separated

Industries

Accepts up to 3

Required Education

None / As per opening description / High School Diploma / Associate’s Degree / Bachelor’s Degree / Master’s Degree / PHD

Urgency

Normal / Urgent

Number of openings

Numerical value

Owner

Email address of the owner of the listing. if left empty it will detail to the Super Admin of the organization.

Followers

Used for people who should be notified about new applicants

Max salary

Numeric

Min Salary

Numeric

Currency

Application followup URL

A url that we can send to them to finish some questionnaires after we receive their application

There are no rows in this table

⁠

* = required information

b. Exporting Candidate & Application Data

For candidate referral tracking and application status updates, the ATS export must include:

Field name

Input Requirements

Notes

External Application ID *

Alpha-numeric

Required for matching applications between systems

Tracker Stage *

Received / In progress

External Job ID *

Alpha-numeric

Necessary for matching with Job

Candidate email *

Email address

Candidate name *

Text

Candidate start date

Date

Filled when a candidate is hired

Candidate zip code

Numeric

Candidate location text

Text

Candidate phone number

Phone number

Candidate LinkedIn URL

URL

There are no rows in this table

⁠

* = required information

c. Configuring the Report Delivery Method

Boon supports two secure methods for receiving these reports:

SFTP-Based Delivery:

Reports are uploaded to a secure SFTP folder, which Boon automatically fetches and processes.

Please contact your Boon customer service rep with the SFTP details and our team will handle the mapping for data and linking it to your account.

Email-Based Delivery:

The ATS exports reports to a dedicated email address generated by Boon. Here’s the process of how to set that up with an example of Importing Jobs:

Go to Openings → Settings → General settings → Sync Job Data via Email

Click Create a mapping structure

Select the fields on the uploaded file that map with the boon fields

⁠

⁠

Save the mapping settings

Get Job Sync Email address

Copy the email and paste it to the scheduled report builder in your ATS.

⁠

⁠

d. Automating the Import Process

Once the report export is configured:

Boon retrieves the scheduled reports and processes them automatically.

The data is mapped to Boon’s system, ensuring seamless updates.

Job postings and candidate application statuses are synchronized as per the scheduled sync frequency

e. Import Logs and Handling Errors

You can access the logs of imports directly from Boon.

⁠

⁠

This section provides details on the status of each import, whether manual or automated via email or SFTP. It also highlights any errors that prevented certain entries from being added correctly, allowing you to resolve them either in the export file or directly within the job data in the ATS.

⁠

⁠

4. Data Sync & Workflow Automation

4.1 Job Listings Synchronization

Boon ensures that job postings from the ATS are regularly synchronized, keeping the referral platform updated with available opportunities.

You can also assign a default owner for jobs and departments within

Openings > Settings⁠

Scroll down to the “Openings settings” section at the bottom of the page

Within the “Owner” field, select “Other” - a separate field will appear below where you can input the name of an active team member within your Boon account.

This default owner value will only be applied to jobs that do not have an existing owner assigned. If a job has an owner assigned to it when sent to Boon, that job owner value will remain applied to the job and override the default job owner setting.

4.2 Candidate Application Flow

Boon handles applications in two ways, depending on the ATS's capabilities:

Application URL Sync Supported (ATS-Directed Applications):

If the ATS provides an application URL for a job, candidates are redirected to apply directly within the ATS.

Boon tracks the referral source and logs the candidate's application status after submission and sync with ATS.

Candidates apply through Boon if no direct ATS application URL exists.

Boon pushes the application details to the ATS via API, ensuring it is correctly recorded.

Referral providers and hiring teams are notified when applications are successfully posted.

4.3 Applications & Candidate Data Sync

Boon syncs candidate and application data with the ATS, ensuring that referral submissions are accurately recorded and tracked.

4.4 Hiring stage mapping

Boon allows users to map their ATS hiring stages to Boon's internal tracker to ensure accurate synchronization of candidate statuses. Each stage corresponds to a key transition in the hiring pipeline:

Applied stage mapping

Used to place the candidate in the correct stage when sending applications from Boon to the ATS.

Hired stage mapping (Multiple Selection Allowed)

When Boon detects a candidate has reached a designated "hired" stage in the ATS, it automatically triggers the referral reward process within Boon.

Multiple ATS hiring stages can be mapped to "Hired" in Boon to accommodate different ATS workflows.

Archived/Rejected stage mapping

Candidates reaching specified "rejected" stages in the ATS will be marked as archived within Boon.

Multiple ATS rejection stages can be mapped to ensure accurate status updates.

Other Interviewing ATS Stages

All ATS stages are displayed exactly as they appear in the ATS.

No stage is hidden, ensuring full consistency between Boon and the ATS hiring pipeline.

Allows recruiters to maintain transparency and alignment between Boon’s referral tracking and ATS hiring processes.

⁠

⁠

4.4 Referral Tracking & Status Updates

Boon tracks the progress of referred candidates and ensures that recruiters have full visibility into their hiring status. The ATS integration allows Boon to:

Record who referred whom and provide real-time updates on their progress inside Boon.

Synchronize the referral’s movement through different hiring stages, from application submission to offer acceptance or rejection.

Notify referrers when their referred candidate moves forward in the process. The notifications can be adjusted in the settings to

4.5 Sync Frequency

Boon offers a flexible sync schedule to meet the needs of different clients:

Standard Sync: Every 24 hours to keep job listings, applications, and referrals updated.

Faster Sync Option: Can be reduced to every 12 hours for clients requiring more frequent updates.

Manual Resync Option: Available for enterprise clients who need immediate data synchronization, accessible within the integration settings.

By providing a structured and flexible synchronization process, Boon ensures that referrals are tracked efficiently, with minimal lag between application submission and status updates.

The sync status will appear in the integration section directly on Boon in addition to the next sync time.

⁠

5. Candidate Referral Source Attribution

How Boon Tracks Referrals within ATS

Boon ensures that every referral is accurately tracked while keeping referral provider data on Boon. Boon sets the application or candidate source as "Boon" or whatever value the client prefers in the ATS. This ensures referrals are correctly attributed.

The source tagging in ATS is handled as follows:

API-Based Submission (No Application URL):

If the candidate applies through Boon, their application is submitted via API, and Boon assigns the source as "Boon" within the ATS.

Application URL-Based Submission (ATS-Directed Applications):

If the candidate applies through the ATS application link, Boon appends a source parameter in the URL.

Example:

Default ATS application URL: https://company.ats.com/jobs/job12345

Boon-enhanced tracking URL: https://company.ats.com/jobs/job12345?source=Boon

This allows the ATS to track the candidate source as "Boon" while ensuring smooth attribution.

Referral Attribution & Transparency

To enhance transparency, Boon provides:

ATS-Integrated Source Tagging: Every referred candidate is tagged appropriately within the ATS so hiring teams can track the referral.

Referral Dashboard: Recruiters can access a dashboard within Boon to view referral statistics, including candidate progress and hiring outcomes.

Referrer Visibility: Boon allows referrers to track the status of their referred candidates within the platform, reducing recruiter workload and improving engagement.

⁠