> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Breezy HR ATS Integration

> Breezy HR connector for Kombo's ATS API

The Breezy HR ATS integration allows you to sync ATS data between Breezy HR and your application through Kombo's unified API. The tool slug for this connector is `breezyhr`.

## Guides and Resources

<CardGroup cols={2}>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18292447852945">
    Step-by-step instructions to connect your Breezy HR account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://breezy.hr/signup">
    Access the Breezy HR sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | department          |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | starting\_at        |       |
      | ending\_at          |       |
      | location            |       |
      | application\_id     |       |
      | stage\_id           |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | required            |       |
      | job\_id             |       |
      | question\_id        |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        BreezyHR provides a list of job admins and users

        * Users in **all\_admins** map to unified type `HIRING_MANAGER`
        * Users only in **all\_users** (not in **all\_admins**) have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to find the job the application needs to be created for, even if jobs are disabled in the scope config.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to find the job the application needs to be created for, even if jobs are disabled in the scope config.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to add the attachments, even if jobs are disabled in the scope config. This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to move the application stage, even if jobs are disabled in the scope config.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to add a result link, even if jobs are disabled in the scope config.
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        All attachment types are considered as OTHER. Breezy does not provide the attachment type in the API response. Due to a limitation in the Breezy API we have to fetch all jobs to get application attachments, even if jobs are disabled in the scope config.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to add the attachments, even if jobs are disabled in the scope config.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to add a result link, even if jobs are disabled in the scope config.
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                            |
    | ------------------------------- | ------------------------------------------------ |
    | Source Writing                  |                                                  |
    | Connection Guide                |                                                  |
    | Prerequisites                   |                                                  |
    | Create credentials              |                                                  |
    | Candidate Cutoff Filtering      |                                                  |
    | Roles                           |                                                  |
    | Job roles (e.g. Hiring Manager) | BreezyHR provides a list of job admins and users |

    * Users in **all\_admins** map to unified type `HIRING_MANAGER`
    * Users only in **all\_users** (not in **all\_admins**) have no unified type. |
      \| API Passthrough |  |
      \| Webhook Subscriptions | Webhook subscriptions require a BreezyHR Pro plan. Kombo automatically creates one webhook endpoint per company in the connection. BreezyHR limits customers to 10 endpoints per owner. candidateAdded: triggered when a candidate is created (applied, sourced, recruited, or referred) candidateStatusUpdated: triggered when an application stage changed (candidate moved from one stage in a pipeline to another) candidateDeleted: triggered when a candidate is deleted via the web application (not fired for GDPR auto-delete purges) companyPositionAdded: triggered when a new position is created companyPositionUpdated: triggered when a position's details are updated (name, description, requirements, etc.) companyPositionStateUpdated: triggered when a position's state changes (e.g. a job is published, unpublished, moved to draft, or closed) companyPositionDeleted: triggered when a position is deleted from the company Not covered: a candidate is updated without a stage change (e.g. profile edits) Not covered: a tag was assigned to a candidate Not covered: an interview was scheduled Not covered: an interview was updated Not covered: screening questions were updated for a job Not covered: a candidate is purged via GDPR auto-delete configuration |
      \|   Automatic Setup |  |
      \| Delta Syncs |  |
  </Tab>
</Tabs>