Integrating Ashby
Capabilities
DataGrail's Ashby integration provides the following capabilities:
| Product | Capability | ||||||
|---|---|---|---|---|---|---|---|
| Request Manager |
|
Before You Start
To successfully configure this integration, please ensure you have sufficient privileges:
- DataGrail User Role: Super Admin, Connections Manager
- Ashby User Role: Admin
Create an Ashby API Key
Create an API key in Ashby that DataGrail uses to access and anonymize candidate data.
- Log in to Ashby as an administrator.
- From the top dashboard menu, select Admin, and then select API Credentials.
- Select + New.
- Enter a Name for the key, such as
DataGrail, and optionally select an Integration Partner. - Grant the required permissions:
Required Permissions
- Candidates: Read and Write
- Hiring Process: Read
- Interviews: Read
- Offers: Read
Select Allow access to private candidate fields and Allow access to confidential jobs if you want these records included in access requests.
- Select Create API Key, and then copy the API Key and store it in a secure location.
Connect to DataGrail
- In DataGrail, navigate to Integrations and select Configure New Integration to search for Ashby.
- Enter the API Key.
- Select Configure Integration.
Ashby doesn't offer a way to delete candidates. For Deletion requests, DataGrail anonymizes the candidate profile, which removes their identifying data and keeps the hiring records. Ashby only anonymizes a candidate once all of their applications are archived, so a deletion request fails while the candidate is in an open hiring process.
Next Steps
Now that you've successfully connected the integration, check out the following resources:
Troubleshooting
If you are unable to successfully connect the integration, review these common troubleshooting steps:
Access requests are missing data
Ashby returns an error for any resource the API key can't read, so the request fails rather than completing with partial data. Confirm the key has Read access to the Candidates, Hiring Process, Interviews, and Offers modules, and that it can access private candidate fields and confidential jobs if your account uses them.
A deletion request failed for a candidate in an open hiring process
Ashby only anonymizes a candidate once all of their applications are archived. If the candidate still has an active application, Ashby rejects the request and the deletion fails. Archive the candidate's applications in Ashby, and then retry the request in DataGrail.
Ensure Required Permissions Are Granted on API Keys/Resources
DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.
Review Required Account Types and User Roles
If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.
See Before You Start to review these requirements.
Technical Details
| Access Type | Synchronous |
|---|---|
| Deletion Type | Synchronous |
API Documentation
Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.