Create an API key for the Orbit API

This is for account admins connecting a careers site or another system to Orbit. You create the key in Orbit and paste it into that system. The developer docs explain how to use it.

Open Settings

Select Settings in the sidebar.

Open API keys

Under Account, select API keys.

Start a new key

Select New key.

Give the key a label

In Label, name where the key will be used, for example your careers page’s address. Later, this label is how you tell whether a key is safe to revoke.

Choose what it can reach

Under What it can reach, choose one:

• Read jobs only: your open roles and their details, nothing writable.
• Read and manage jobs: also creates, edits, publishes and closes roles. Give this only to a system you run.
• Screening: the candidate screening endpoints. Only for a server you control.

Create the key

Select Create key.

Copy the key

Select Copy this key and store it somewhere safe. This is the only time you will see it.

Confirm you saved it

Tick I’ve saved this key somewhere I can get it back., then select Done — close this.

I don't see API keys in Settings

Only account admins can create and revoke API keys. Ask an admin on your account.

The copy button didn't work

Your browser may have blocked the copy. Select the key on screen, copy it by hand, then tick the box to confirm you saved it.

If you lose a key

Orbit stores only a hash of the key, so nobody can show it to you again. Replace it in this order, so your careers page doesn’t go down:

1. Create a replacement key.
2. Put the new key into your careers site and check your jobs still appear.
3. Only then revoke the old key.

Two keys can be active at once, which is what makes a clean swap possible.

Revoke a key

On API keys, select Revoke next to the key, read what will stop working, then select Revoke now. This takes effect on the next request and can’t be undone.

Use the key

The developer docs cover authentication, endpoints and examples. Start with Create an API key in the Wipperoz developer docs, or select Read the API docs on the API keys screen.