Skip to main content

Integrations: Create an API key (API token)

How to get your RelayCam API key or API token: open Integrations, create a key, and use it to build your own integration, connect a tool like Zapier, or share it with a developer.

Written by Rhet Porter

What this is: an API key is a private password that lets another tool, script, or developer talk to your RelayCam account, for example to create projects automatically. You create it yourself in about a minute.

What you'll need

  • A company admin login. Only admins can create and manage API keys.

  • An active RelayCam subscription. The Integrations page, and API access, are available on active paid accounts.

  • A computer. API keys are created on the RelayCam web app.

Create your API key

  1. Log in to RelayCam. On your computer, open your web browser and go to web.relaycam.com.

  2. Open Integrations. In the left-hand menu, click Integrations. It's the last item in the list, after Alerts.

    Don't see Integrations? Only company admins on an active subscription see it. Ask the person who manages your RelayCam account to create the key, or to make you an admin.

  3. Click the API Keys tab. At the top of the page there are two tabs: Apps and API Keys. Click API Keys.

    Shortcut: on the Apps tab, find the RelayCam API card and click View API Keys.

  4. Start a new key. Click the New API Key button in the top-right corner.

  5. Name it. A box called Create New API Key pops up. Name the key after the tool or script that will use it, such as Zapier or Google Calendar. That way you'll know what to turn off later if you ever need to. Then click Create API Key.

  6. Copy your key. A box called Copy Your New API Key appears with your key in it. Click Copy, paste the key into the tool or message you're setting up, and then click Done.

Keep it private. Treat your key like a password. Store it somewhere safe and don't share it in public places like screenshots, group chats, or shared documents. Anyone with the key can act on your RelayCam account.

You can find your key again any time on the API Keys tab. For safety it's hidden there, showing only the last 4 characters, but the Copy button next to it still copies the full key.

Use your key

Whoever sets up the connection (you, your developer, or a tool like Zapier) needs two things:

  • The address to send requests to: https://api.relaycam.com/v1

  • Your key, sent in the Authorization header of every request, with the word Bearer in front of it: Authorization: Bearer YOUR_API_KEY

To check that a key works, a developer can send a request to https://api.relaycam.com/v1/health with that header. A successful reply says that the External API is running.

Developer? See the full list of what you can do with the API in the RelayCam API Documentation. You can also open it from the API Documentation link at the top of the API Keys tab.

Turn a key off or delete it

Each key on the API Keys tab shows its name, when it was created, and whether it's Active or Disabled. Click the three dots at the right of a key to:

  • Disable the key. Anything using it stops working right away, and you can turn it back on later with Enable.

  • Delete the key. Anything using it stops working immediately, and this can't be undone. You'll be asked to confirm first.

If a key is ever shared by mistake, delete it and create a new one.

Tip: create a separate key for each tool. If you need to stop one connection, you can switch off just that key without breaking the others.

Good to know

  • Each key can make up to 240 requests per minute, and up to 60 per minute for requests that create or change things.

  • Requests are refused if the key is disabled or deleted, or if your company's subscription isn't active.

If something goes wrong

What you see

What to do

There's no Integrations item in the menu

You need to be a company admin on an active subscription. Ask your account admin for help.

The other tool says the key is invalid or unauthorized (401)

Check that the key was pasted in full, with nothing extra before or after it. Make sure the key is Active on the API Keys tab, and that it hasn't been deleted. If the request is made directly, make sure the word Bearer and a space come before the key.

The tool says you're making too many requests (429)

Wait a minute and try again, and slow down how often the tool sends requests.

You see Couldn't load your API keys

Click the retry button, or refresh the page. If it keeps happening, message us.

Anything else

Take a screenshot of what you see and send it to us. We'll sort it out.

Did this answer your question?