Skip to main content

Ashby

Recruiting: agents read jobs, candidates and applications, and can add notes, through Ashby's API.

Connect it with: API key. Ashby's own documentation: https://developers.ashbyhq.com/docs/authentication.

What agents can do​

Connect Ashby so the agents working your tasks can reach it. With it connected, they can:

  • List open jobs and their hiring teams, stages and openings.
  • Look up candidates and their applications, interviews and feedback.
  • Add notes to a candidate, or move an application to another stage when the key has write access.
  • Summarize the pipeline: applications per stage, time in stage, source of hire.

Before you start​

  • An Ashby account with the Admin permission (only admins can create API keys).
  • Agreement on which Ashby modules agents may read or change: every key carries its own per-module permissions.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Ashby​

Jaah connects to Ashby with an API key, not with a sign-in button.

Connect with an API key​

Find each value first:

  • API key: In Ashby (as an admin), open Admin > API Keys (app.ashbyhq.com/admin/api/keys) and select Create API Key. Name it Jaah, tick Read for Jobs plus every module agents need (Candidates, Applications, Interviews; add Write only where agents should change data), then save and copy the key - Ashby shows it once.

Then add it to Jaah:

  1. In Jaah, open Secrets, select New, and pick the Ashby card.
  2. Name the secret and choose who can use it.
  3. Fill in API key.
  4. Select Save. Jaah tests the secret straight away (see Test the connection).

Jaah encrypts what you type and never shows it again — not to you, and not to an admin.

Use your own OAuth app​

Not used: Jaah connects to Ashby with an API key, not through an OAuth app.

Test the connection​

Select Test on the secret. Jaah calls Ashby's API once (POST https://api.ashbyhq.com/job.list) with the stored values, and shows whether Ashby accepted it, or which value Ashby refused and the status it answered. Jaah also tests automatically when you save or reconnect.

The last result and its time stay on the secret's page, so you can see whether it still works without testing again.

Who can use it​

Every secret has an owner, and the owner decides who can use it:

  • Personal — only your own tasks can use it. This is the default.
  • Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
  • Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.

More on owners and access: How secrets work.

Use it in an agent session​

An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:

  • org/<name> for an organization secret,
  • projects/<project>/<name> for one attached to a project,
  • me/<name> for your personal one.

A key connection hands the agent its fields: api_key.

Tell the agent in your task description which secret to use, for example “use the Ashby secret org/ashby”.

Manage, rotate or disconnect​

Everything is on the secret's page under Secrets:

  • Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at Ashby once the test passes. Steps: Replace or delete a secret.
  • Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Ashby's side too, revoke or delete the key at Ashby.

Limitations​

  • The key reaches only the modules ticked when it was created; Jaah's test calls the job list, so the key needs at least Read on Jobs.
  • Confidential jobs and private fields are hidden from a key unless its settings explicitly allow them.
  • An Ashby key belongs to the organization, not a person: anything agents do appears as done through the API.
  • Agents can do only what the connected Ashby account allows.

Troubleshooting​

Test says Ashby rejected the API key (401 or 403)

The key was mistyped or deactivated, or it lacks Read access to Jobs. In Admin > API Keys, check that the key is active and that Jobs has Read ticked; create a new key if needed and select Replace on the secret.

Test says Ashby did not answer with an API response

Ashby answered with success false, which usually means the key is missing a permission the call needs. Open the key in Admin > API Keys, tick Read for Jobs, and test again.

An agent cannot see a confidential job or a private field

Keys skip confidential jobs and private fields by default. Open the key in Admin > API Keys and enable access to confidential jobs and projects, or to private fields, only if agents truly need them.

Still stuck? Select Test and read the result: it names the value Ashby refused and the status it answered.

FAQ​

Can I give agents read-only access?

Yes. When creating the key, tick only Read for each module. Agents can then look things up but not change anything in Ashby.

How do I revoke the key in Ashby?

Open Admin > API Keys and deactivate or delete the Jaah key. Agents lose access on their next call.

Can Jaah or an admin see the key or token?

No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.

Can I connect more than one Ashby account?

Yes. Add one secret per account, each with its own name, and tell the agent which one to use.