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

# Connect Ashby

> Set up and verify the Ashby integration to automatically create and update offers in ClearOffer.

Connect your Ashby ATS so approved offers in Ashby automatically appear in ClearOffer as unpublished offers that you can review and send.

<CardGroup cols={2}>
  <Card title="What you'll get" icon="sparkles">
    Approved Ashby offers automatically appear in ClearOffer, with optional custom field mapping.
  </Card>
</CardGroup>

## Prerequisites

* Ashby admin access (to create an API key)

## Connect Ashby

<Steps>
  <Step title="Open Ashby">
    Go to Ashby and navigate to the Admin panel.
  </Step>

  <Step title="Navigate to Integrations">
    From the left sidebar, click on `Integrations`.
  </Step>

  <Step title="Search for ClearOffer">
    On the Integrations page, search for `ClearOffer`.
  </Step>

  <Step title="Create API Key for ClearOffer">
    Click on the ClearOffer card to open the integration settings, and then click on `Create API Key for ClearOffer`.
  </Step>

  <Step title="Copy the API Key">
    Copy the API Key and save it somewhere safe and secure.
  </Step>

  <Step title="View API Key Settings">
    Close the API Key modal, then click on `View API Key Settings` button.
  </Step>

  <Step title="Update API Key Settings">
    Within the API Key Settings, under `Other Permissions`, check the box for `Allow access to confidential jobs and projects?`, and then click on the `Save` button.

    <Tip>
      When creating your Ashby API key, if you want to scope the API key based on principle of least privilege, ensure it only has the following permissions:

      * Candidate Read
      * Hiring Process Metadata Read
      * Offers Read and Write
      * API Key Read and Write
      * “Allow access to confidential jobs and projects?” checked
              <img src="https://mintcdn.com/clearoffer/_WPkcxqi1yMDWq2U/images/ashby-api-key-settings.png?fit=max&auto=format&n=_WPkcxqi1yMDWq2U&q=85&s=2287383251b041ca7e9f77311b6978eb" alt="Ashby API Key Settings" width="630" height="822" data-path="images/ashby-api-key-settings.png" />
    </Tip>
  </Step>

  <Step title="Open ClearOffer">
    Open ClearOffer and click on the `Company` toggle in the sidebar, then click on `Integrations` to open the Integrations page.
  </Step>

  <Step title="Setup Ashby Connection">
    In the Ashby card, click `Connect Ashby`, and paste the API key you copied earlier.

    <Warning>
      Treat your API key like a password. Do not share it in chat or tickets.
    </Warning>
  </Step>

  <Step title="Choose events">
    Select which Ashby events should sync to ClearOffer:

    * <strong>Offer Create</strong> — create a new ClearOffer when a new offer is created in Ashby
    * <strong>Offer Update</strong> — update the matching offer in ClearOffer when it changes in Ashby
  </Step>

  <Step title="Configure">
    Click `Configure Integration`. ClearOffer will validate your key and automatically create the required webhooks in Ashby.

    <Check>
      You should see a `Connected` badge on the Ashby card once setup is complete.
    </Check>
  </Step>
</Steps>

## What gets synced

| Data Type     | What Gets Synced                                                                                         |
| ------------- | -------------------------------------------------------------------------------------------------------- |
| Basic Info    | Name, email, role, start date                                                                            |
| Compensation  | Base salary, currency                                                                                    |
| Custom fields | Any custom fields you map via Custom Field Mapping (Equity details, department, location, manager, etc). |

<Info>
  Only offers in Ashby that are ready for candidate delivery are synced. Drafts or unapproved offers aren't imported.
</Info>

## Verify the connection

* Create or approve a test offer in Ashby
* In ClearOffer, check your Offers list for a new unpublished offer
* If Offer Update is enabled, make a small change in Ashby and confirm it updates in ClearOffer

## Troubleshooting

<AccordionGroup>
  <Accordion title="Invalid API key or permissions">
    Regenerate the key in Ashby with the required permissions and re-enter it in ClearOffer.
  </Accordion>

  <Accordion title="Connected but no offers appear">
    * Confirm the offer in Ashby is approved and ready for candidate delivery (status is `WaitingOnCandidateResponse`)
    * Ensure you enabled the relevant event (`Offer Create` or `Offer Update`)
  </Accordion>

  <Accordion title="We couldn't auto-create webhooks">
    Follow the in-app manual setup steps or contact support with a timestamp of your attempt.
  </Accordion>
</AccordionGroup>

## Next steps

Map your Ashby custom fields to ClearOffer so additional information (like equity details, department, location, welcome messages, etc) is populated automatically.

<Card title="Set up custom field mapping" icon="sliders" href="/integrations/custom-field-mapping">
  Map Ashby custom fields to ClearOffer fields to enrich synced offers.
</Card>