Documentation Index

Fetch the complete documentation index at: https://kb.pigment.com/llms.txt

Use this file to discover all available pages before exploring further.

Connect Pigment with Ashby

Prev Next

Ashby is an applicant tracking system (ATS) that helps organizations manage recruiting processes, including job openings, candidate applications, interviews, and offers. This article explains how to connect Ashby to Pigment and import recruiting data into a Block. During import setup, you can choose the type of Ashby data to import, including Applications, Openings, and Offers, and configure available filters and custom fields for the selected entity.

⚠️ Important

You need to be a Pigment Workspace Admin to configure the connector.

Connect Ashby and import data into Pigment

The Ashby connector imports recruiting data from Ashby into Pigment. To use the connector, generate an API key in Ashby, establish a connection in Pigment, and then configure an import into the target Block.

When setting up an import, select the type of data to import:

  • Applications

  • Openings

  • Offers

Depending on the selected entity type, you can apply available filters and select any custom fields to include in the import.

Application imports

Application imports include a set of default fields and can be filtered by one or more Application statuses:

  • Hired

  • Active

  • Lead

By default, only Applications with a status of Hired are imported to maintain backward compatibility with existing imports. Existing imports continue to use the Applications entity and behave as before unless the selected entity or filters are changed.

Expand the accordion below to view all available default Application fields.

Default Application fields

  • Application ID

  • Employee name

  • Department

  • Job ID

  • Job title

  • Target start date

  • Actual start date

  • Salary

  • Salary currency

  • Application status

  • Current interview stage

  • Source

  • Archive reason

  • Archived at

  • Opening ID

Offer imports

Offer imports include a set of default fields and can be filtered by one or more offer statuses and acceptance statuses. If no filters are selected, all offer records are imported.

Expand the accordion below to view all available default offer fields.

Default offer fields

  • Offer ID

  • Application ID

  • Offer status

  • Acceptance status

  • Decided at

  • Start date

  • Salary

  • Salary currency

  • Opening ID

  • Approval status

  • Version created at

Opening imports

Opening imports include requisition data from Ashby.

Expand the accordion below to view all available default opening fields.

Default opening fields

  • Opening ID

  • Identifier

  • Opening state

  • Opened at

  • Closed at

  • Close reason ID

  • Is archived

  • Archived at

  • Target hire date

  • Target start date

  • Is backfill

  • Employment type

  • Team ID

  • Job IDs

  • Location IDs

  • Description

  • Author ID

  • Hiring Team User IDs

  • Hiring Team Names

  • Hiring Team Emails

  • Hiring Team Roles

Establish the connection between Ashby and Pigment

Before importing data into Pigment, you must establish a connection between Ashby and Pigment. First, generate an API key in Ashby. A Pigment Workspace Admin can then create the connection and define which Pigment Applications can use it. Once the connection is configured, you can set up an import and select the connection.

Step 1: Generate an Ashby API key

⚠️ Important

To generate an Ashby API key, your role in Ashby must be set to Org Admin. The API key must have the required permissions for the data you want to import:

  • Applications require candidatesRead.

  • Openings require jobsRead.

  • Offers require offersRead.

  1. Sign in to Ashby and select Admin in the top navigation bar.

  2. Select Integrations in the left-hand navigation panel.

  3. Search for the Pigment integration and select + Create API Key for Pigment.

  4. Copy the generated API key and store it securely. You will need it when configuring the connection in Pigment.

Step 2: Set up the Ashby Connector in Pigment

  1. From the Workspace homepage, go to Settings, then select Integrations.

  2. Select + Add next to the Ashby integration.

  3. Select Set up a connection and complete the following fields:

  • Name. Enter a name for the connection (for example, Ashby connection).

  • Application access. Select the Pigment Applications that can use this connection from the drop-down menu.

  • API key. Enter the API key generated in Ashby.

  1. Select Setup.

  2. (Optional) Select the three-dot menu, then select Edit connection or Remove connection.

  3. (Optional) Select + Set up a new connection, to add a new connection.

  4. Select Done.

Step 3: Import Ashby data into Pigment

When the Ashby connection is configured, go to an Application where the connection is available.

  1. Select Import Data for the Block you want to import data into.

    For example, if you are importing into a Transaction List, open the List, then select Import data.

  2. Select the Integration tab, then select the previously configured Ashby connection from the drop-down menu.

  3. Select the entity type to import:

  • Applications

  • Openings

  • Offers

Depending on the selected entity type, configure the available filters and select the custom fields you want to include in the import.

Update Application access

If you do not see the Ashby connection you configured, make sure the current Pigment Application is listed in the Application Access list for the connection.

To update access:

  1. Go to Settings.

  2. Select Integrations and confirm that the Application is included in the connection's Application Access list.