Table of contents
Connect Ashby to Guide to automatically sync jobs, candidates, interviewer profiles, and interview schedules. Guide will automatically create personalized guides for each candidate as you add them to Ashby.
In this article, we cover the steps needed to connect Ashby with Guide:
Verify your Ashby permissions
Step 1: Create an Ashby API key
Step 2: Add your Ashby API key to Guide
Step 3: Enable real-time updates with Ashby Webhooks
Read before continuing: You will need Ashby Admin access and permission to manage API keys and Webhooks in order to connect Ashby and Guide.
Verify your Ashby permissions
Review your permissions level in Ashby:
Log in to Ashby as an Admin user.
Navigate to Admin Dashboard > API Keys and confirm you have permission to create and manage API keys.
Navigate to Admin Dashboard > Webhooks and confirm you have permission to create and configure Webhooks.
Step 1: Create an Ashby API key
Guide and Ashby need a secure way to communicate to share the relevant candidate and job information that powers your Guide account. We achieve this with the Ashby API. In this section, you’ll generate a private API key that enables Guide to access your Ashby data.
Follow these steps to generate your Ashby API key for use with Guide:
Log in to Ashby as an Admin user and navigate to Admin Dashboard > API Keys.
Click New to create a new key.
In the dialog window that appears, enter a descriptive name (e.g., “Guide Integration Key”).
From the Integration Partner dropdown, select Guide.
Ensure the following permissions (scopes) are enabled for this key:
Candidates Read/Write
Jobs Read/Write
Interview Schedules Read/Write
(Any additional scopes required by Guide)
Click Create API Key.
Copy and securely store your new API key—this is the only time Ashby will reveal the key.
Click Done once you’ve saved the key.
Step 2: Add your Ashby API key to Guide
Now that you’ve created and saved your unique Ashby API key, add it to Guide to establish the connection.
Log in to Guide and navigate to Settings > Integrations.
Locate the Ashby integration panel and click Connect.
In the modal that appears, paste the Ashby API key you generated in Step 1 into the Ashby API Key field.
Click Connect.
After a successful connection, Guide will display a confirmation message indicating Ashby is linked.
Step 3: Enable real-time updates with Ashby Webhooks
Webhooks enable Guide to receive real-time updates from Ashby whenever there is a candidate-related activity or changes in your Ashby ATS. Without Webhooks, Guide could fall behind Ashby, resulting in stale data. This process typically takes 5–10 minutes and is essential for maintaining accurate candidate guides.
Follow these steps to configure Ashby Webhooks:
Open two browser tabs side-by-side:
Tab 1: Guide’s Settings > Integrations page (where the Ashby integration is configured).
Tab 2: Ashby’s Admin Dashboard > Webhooks page.
In Guide (Tab 1), click Configure Webhooks on the Ashby integration panel. Guide will list the Webhook events it needs (e.g., candidate.created, candidate.updated, interview.scheduled, interview.updated). For each event, Guide shows:
Webhook URL
Webhook Secret (if applicable)
Event Name
In Ashby (Tab 2), click New Webhook and enter the following details exactly as shown in Guide (Tab 1):
Name: A descriptive name (e.g., “Guide – Candidate Created”).
URL: Paste the Webhook URL copied from Guide.
Secret (if Guide provides one): Paste the Webhook Secret.
Event: Select the corresponding event from the dropdown (e.g., candidate.created).
Enabled: Set to Yes or Active.
Click Save.
Return to Guide (Tab 1). The first Webhook row should now turn green or display “Connected.”
Repeat Steps 3–4 in Ashby and Guide for each remaining Webhook event listed in Guide.
Once all Webhooks are green, Guide will begin receiving real-time data from Ashby.
Pro Tip: Keep both Ashby and Guide Webhook configuration pages visible side-by-side to speed up setup and reduce copy/paste errors.
If you run into any trouble setting up the permissions required, configuring API key scopes, or have questions about specific Webhook event names, please reach out to us at support@guide.co; we’re happy to help!