Yardstik brings better trust and safety tools for companies that need to quickly screen, verify, and hire people at scale.
Yardstik's integration with Greenhouse Recruiting allows you to order and review background check screenings for candidates. To use this integration, you need a Yardstik account with the ability to create custom integrations.
Set up the integration
Create a secret key in Yardstik
First, navigate to the Yardstik developer page and click the Integrations section. Edit the Greenhouse integration. Generate an API key to use as your Secret Key in Greenhouse.
Copy the API key you just generated, and log in to Greenhouse Recruiting.
Create a webhook
With your Greenhouse API key from Yardstik, create a webhook in Greenhouse Recruiting. Follow the steps in this article to create your webhook, and use the values listed below to configure the webhook:
- Name: Yardstik integration
- When: Candidate has been hired
- Endpoint URL: Enter the Yardstik API URL
- Secret key: Enter the API key from Yardstik
Note: For When, you may also use Candidate has changed stage. So the webhook will only fire once, you need to configure a custom stage in your job's Greenhouse Recruiting hiring flow with the name Yardstik BGC.
In the Advanced Settings options, enter the following snippet to create a header to send the secret key with the request: x-yardstik-api-key: {your-yardstik-generated-api-key}
Create your webhook.
Create a custom field
Next, create a custom field to select the Yardstik Account Package for the candidate. When the integration is set up, this field will automatically include all of your available Yardstik Account Packages.
Follow the steps in this article to create a custom job field using the details below:
- Name: Yardstik Package
- Field type: Single-select, with one option of "None." Make this field required.
Mark the field as Private, and Save the field.
Create a Harvest API key
Next, create a Harvest API key for the integration. Follow the steps in this article to create a Harvest API key, using the details below:
- API type: Harvest
- Partner: Yardstik or Unlisted Vendor
- Description: Yardstik Harvest API Key
Verify that the following permissions are selected for the Yardstik integration:
Candidates
- GET: Retrieve candidate
- PATCH: Edit candidate
- POST: Add note
Jobs
- PATCH: Update job
Custom fields
- GET: Get custom fields
- POST: Create custom field options
- PATCH: Update custom field
- DELETE: Delete custom field
Custom field options
- GET: Custom field options
- POST: create custom field options
- DELETE: Remove custom field options
- PATCH: Update custom field options
Copy the created API key to a secure location for use in the next step.
Enable on Yardstik
Paste your Harvest API key into the Greenhouse Harvest API Key field in Yardstik. Enter the name of the Greenhouse Recruiting custom job field in Yardstik. And finally, enter a Greenhouse Recruiting Site Admin user ID to be associated with the integration.
Tip: Create an ISU, or integration system user, instead of using a personal Site Admin account to authenticate the integration. Rather than requiring a specific user at your organization to authenticate the integration, which could cause downstream errors if the person loses permissions or can't access Greenhouse Recruiting, an ISU allows you to create a solid infrastructure for your organization's integration needs.
When finished, click Update.
After the configuration is complete, turn on the Greenhouse Recruiting integration in Yardstick to enable the flow of data.
Use the integration
When you create a job, your custom job field will automatically include the account packages you have set up in Yardstik.
Once a candidate passes through the job stage that you selected when creating the webhook, the Yardstik invitation will automatically be sent.
When the status of the Yardstik report changes, you'll be notified in the Private Notes section on the candidate's profile.