Breezy HR integration overview

Breezy HR integration overview

Overview

Breezy HR is an applicant tracking system (ATS) that helps teams manage positions and candidates throughout the hiring pipeline.

Persona’s Breezy HR integration connects your recruiting workflows to identity verification and investigation workflows, so teams can pull candidate context into Persona and then write key outcomes back to Breezy HR—without manual copy/paste.

Benefits

Reduce manual updates: Automatically create or update Breezy HR candidate records when events happen in Persona, keeping your ATS aligned with the latest identity outcomes.

Keep recruiters in their system of record: Share verification outcomes back to Breezy HR so hiring teams can make decisions with the right context where they already work.

Scale consistent processes: Standardize when and how candidate profiles are created, enriched, or updated across roles and teams using Persona Workflows.

Integration Features

Persona’s Breezy HR integration supports streamlined candidate management and two-way workflows between Persona and Breezy HR. Key capabilities include:

  • Company & Position discovery: Browse the companies and positions available in your Breezy HR account to power dynamic workflow configuration.
  • Candidate syncing: Retrieve candidates for a specific position so you can match Persona activity to the right candidate record.
  • Candidate creation: Add new candidates to a position from Persona, including core profile details (and optional enrichment fields).
  • Candidate updates: Update an existing candidate record so outcomes like investigation status or verification notes can be reflected in Breezy HR.
  • Cross-position lookup: Search for candidates across a company by email address to support deduplication and record matching.

Setting up the Breezy HR integration

Prerequisites

To set up the Breezy HR integration, ensure you have:

  • Admin access to your Breezy HR account
  • Necessary API permissions to access Breezy HR credentials

Setting up the Breezy HR credentials

  1. In Breezy HR, retrieve an API access token you can use for API requests. Breezy provides a sign-in endpoint that returns an access_token, which is then used as the Authorization header value for subsequent requests.
  2. In the Persona Dashboard, navigate to Integrations > Marketplace and click on Breezy HR.
  3. Click on Add Credential at the top of the page.
  4. Enter a credential nickname and click Continue.
  5. Paste your Breezy HR access token when prompted and save the credential.
  6. (Optional) Use the Test option on the credential to confirm Persona can connect successfully.

Using the Breezy HR integration in a workflow

  1. Create a new workflow, or open an existing workflow you’d like to update.
  2. Add a new action step > Integrations.
  3. Select the Breezy HR integration and choose your saved Breezy HR credential.
  4. Select the operation you want to perform (for example, Search Candidates or Update Candidate) and map Persona data into the Breezy HR input fields.
  5. Save and publish the workflow.

Breezy HR Operations Overview

In addition to syncing field values, Persona can create candidates, update candidate profiles, and search for candidates using Breezy HR’s API. These actions support seamless two-way workflows, letting teams manage investigations without switching platforms. See below for a comprehensive list of available Workflow Action steps and possible configurations for the Breezy HR integration:

List Companies Workflow Action Step

Use this step to retrieve the list of companies your Breezy HR user has access to. This is typically the first step when configuring workflows, since other Breezy HR actions require you to scope actions to the correct company.

Configuration Steps:

  • Provide values for required fields:
    • None
  • Optionally add:
    • None

List Positions Workflow Action Step

Use this step to retrieve positions for a specific company. This helps teams target workflows to the right role (for example, running verification only for roles in a specific department or location) and ensures downstream steps reference the correct position.

Configuration Steps:

  • Provide values for required fields:
    • Company ID
  • Optionally add:
    • State (for example, to filter by whether a position is published, closed, or archived)

List Candidates Workflow Action Step

Use this step to pull candidates for a specific position, so your workflow can find the right candidate record and apply the correct follow-up action. This is useful when you want to enrich Persona cases with recruiting context (like a candidate’s current stage) before deciding what to do next.

Configuration Steps:

  • Provide values for required fields:
    • Company ID
    • Position ID
  • Optionally add:
    • Page size
    • Page
    • Sort order (for example, by most recently updated)

Add Candidate Workflow Action Step

Use this step to create a new candidate in Breezy HR and associate them with a specific position. It’s commonly used when Persona is the system initiating a downstream recruiting record (for example, after an inquiry is created or after a candidate passes a specific identity check) so recruiters don’t need to create the record manually.

Breezy HR requires a candidate name, and an email address is required in cases where the candidate is marked as having applied (versus being sourced).

Configuration Steps:

  • Provide values for required fields:
    • Company ID
    • Position ID
    • Candidate name
  • Optionally add:
    • Origin (for example, sourced vs applied)
    • Email address (required when origin is applied)
    • Phone number
    • Address
    • Summary / headline
    • Tags
    • Work history
    • Education
    • Social profiles
    • Custom attributes
    • Cover letter
    • Stage actions enabled (controls whether configured stage actions are executed for certain candidate origins)

Update Candidate Workflow Action Step

Use this step to update an existing candidate record when something changes in Persona, such as a case being escalated, resolved, or requiring follow-up. This enables teams to keep Breezy HR as the source of truth for candidate status and notes, while Persona drives the underlying verification and investigation workflows.

Only the fields you provide will be modified, which makes it safe to update specific attributes without overwriting the entire candidate profile.

Configuration Steps:

  • Provide values for required fields:
    • Company ID
    • Position ID
    • Candidate ID
  • Optionally add:
    • Name
    • Email address
    • Phone number
    • Address
    • Summary / headline
    • Source
    • Tags
    • Social profiles
    • Cover letter

Search Candidates Workflow Action Step

Use this step to find candidates across all positions within a company by email address. This is helpful for deduplication (for example, if the same candidate appears in multiple roles) and for matching a Persona event to the right Breezy HR record before updating or taking action.

Configuration Steps:

  • Provide values for required fields:
    • Company ID
    • Email address

FAQs

How do I find the Company ID, Position ID, or Candidate ID to use in a workflow? Use the List Companies, List Positions, and List Candidates steps to discover the IDs available to your Breezy HR credential. A common setup is to first select the company, then the position, and then retrieve or search candidates before performing an update.

Can I update only one field on a candidate without changing anything else?

Yes. The Update Candidate step is designed to modify only the fields you include, so you can write back a specific outcome (like a tag, summary, or note field your team uses) without overwriting other candidate details.

When should I use Search Candidates vs. List Candidates? Use Search Candidates when you have an email address and want to find a candidate across the entire company (including across positions). Use List Candidates when you already know the position and want the candidates for that specific role (for example, to evaluate everyone currently in a given pipeline).