How to get started with Ashby on Zapier – Zapier

## Connect to Ashby on Zapier

Ashby uses API keys to authenticate your account on Zapier.

### Required authentication fields

*   API key.

### Additional authentication instructions

To create an API key through the Zapier integration listing in the Ashby integrations marketplace, you can follow the steps below (recommended). Only one API key can be set up using this method:

1.  Log in to your **Ashby Account.**
2.  Click **Admin.**
3.  Click **Search.**
4.  Search for **integrations**.
5.  Click the **Integrations tile**.
6.  On the integrations page, search for '**Zapier**'
7.  Click the **Zapier integration listing** that appears in the search results.
8.  Click **Enable**.
9.  Copy the **API Key** to your clipboard. 

An alternate method for creating an API Key in Ashby: 

1.  Log in to your **Ashby Account.**
2.  Click **Admin.**
3.  Click **Search.**
4.  Search for **API Key**.
5.  Click the **'API Keys' search result**.
6.  Click **New** in the top right-hand corner of the page.
7.  Provide a **name** for the API key
8.  Select **Zapier** as the integration partner associated with the Integration.
9.  Click **Create**
10.  Copy the **API Key** to your clipboard. 

Learn more about [authenticating your Ashby account](https://platform.zapier.com/docs/auth) in Zapier.

## About Ashby's app

|     |     |     |
| --- | --- | --- |
| Are self-hosted or cloud-hosted accounts supported? | Cloud-hosted accounts only |     |
| Is a paid Ashby plan required? | Yes | All Ashby All-in-One plans support the Zapier integration.  <br>View Ashby's [plans](https://www.ashbyhq.com/pricing). |
| Are any special account permissions required? | Yes | You need to be an Organization Admin. Users cannot create an API key or view the integration's configuration page if they are not an Organization Admin.  <br>Learn more about Ashby's [account permissions](https://ashbyhq.notion.site/Ashby-Permissions-a48eda7c07ad46f0bcd2b3f39301a9de). |
| Are there usage limits? | Yes | Rate limit of 1,000 requests per minute per API key.  <br>Learn more about Ashby's [usage limits](https://www.notion.so/ashbyhq/How-do-I-generate-an-API-key-58d3409382014a3d80c3b08e982644d7?pvs=4#83d5eac919c34fd5b4da2ea1a7b6fe98). |
| Are there pagination limits? | Yes | Ashby's paginated endpoints return 100 results per page. |
| Do trigger samples use real data from your account or generic data? | Real trigger samples |     |
| Are custom fields supported? | Yes | Custom fields on all objects that support them in Ashby. If a custom field on an object has a value set, it will be included on the object when it's provided to Zapier in a property called \`customFields\`. Each custom field includes its ID, its title, and its value. If a custom field exists on an object, but it has no value assigned to it, the custom field will not be included on the object. If an object has no custom field values assigned to it, the customFields property will not be included on the object.  <br>Learn more about Ashby's [custom fields](https://www.notion.so/ashbyhq/Custom-Fields-dc745794499c4086b49971328707957f). |
| Do update actions overwrite or append to existing data? | Overwrite existing data | Actions that support updating existing objects (for instance, our Update Candidate action) will overwrite existing data in the object being updated. If you update a candidate's name using the Update Candidate action, the candidate's original name will be overwritten. All other data about the candidate that has not been updated will remain unchanged. |
| Is there any additional info? | Yes | Find additional info about [using Ashby](https://ashbyhq.notion.site/Zapier-a8a4dfe224764a168eed87a7a98db7d2) in Zapier. |