Ashby | API Key Authentication

This article provides guidance on creating an API key to link your Ashby account to Oyster.

Prerequisites

  • You have Admin access to your company’s account.
  • You are logged in to Ashby with your Admin credentials.

Steps

  1. Sign in to Ashby and click Admin on the top navigation bar.
Ashby - Step 1.png
  1. On the left hand navigation bar, click Integrations > API Keys.
Ashby - Step 2.png
  1. Click + New on the top right corner.
Ashby - Step 3.png
  1. Give a name to the new API key and click Create API Key. For example, "Oyster integration". 
Ashby - Step 4.png
  1. Select the Read checkbox for the following permissions:
    • Jobs
    • Candidates
    • Interviews

    • Hiring Process Metadata

    • Organization

    • Offers

  2. Click Save and Continue.
Ashby - Step 5.png
  1. Your API Key has been generated! Click to copy the API Key and store it somewhere safe. 
  2. Go to Connecting to Oyster to complete the remaining steps in Oyster's platform. 
Ashby - Step 7.png

Was this article helpful?

0 out of 0 found this helpful