Create and revoke API tokens

What a token can do

A token acts for the person who created it, in the team that was active at that moment. It can only do what you let it do when you create it. You choose one of these:

  • Control screens and scenes: see screens, content and scenes, show content on a screen, and start and stop scenes. Use this for Bitfocus Companion.
  • Read only: see screens, content and scenes, nothing else.
  • Full access, including creating designs: everything above, and creating designs.

If the person who made the token loses access to the team, the token stops working.

Create a token

  1. Go to Settings > Connections.
  2. Under API tokens, click New API token.
  3. Give the token a name, for example the name of the venue or the program that uses it.
  4. Under Access, choose what the token may do.
  5. Click Create token.
  6. Click Copy and store the token in a safe place, for example in the program that needs it.
  7. Click Done.

You see the token only once. If you lose it, revoke it and create a new one.

The token works in the team that is active when you create it. For the screens of another team, switch to that team first and create a separate token. Use a separate token for each program, so you can revoke one without stopping the others.

By default the owner and admins can create tokens. Your role decides this. You change this per role in Manage teams.

Mail when a token is created

When someone creates a token, they and the owners of the account get an email. The email says which token it is, who made it, for which team, when, and what it may do. The email never contains the token itself. If you did not expect a token, revoke it right away.

See your tokens

The card API tokens shows for each token:

  • the name and the kind of access;
  • the last four characters of the token, so you can tell tokens apart;
  • the team;
  • when it was last used, or Never used.

The owner sees the tokens of everyone in the account. Everyone else sees their own.

Revoke a token

  1. Go to Settings > Connections.
  2. Click Revoke next to the token.
  3. Confirm with Revoke.

Everything that uses the token stops right away.

Tokens that expire

A token that has not been used for a year is revoked by itself. A token that was never used counts from the day it was created. Create a new token if you need one again.

Limit

An account can have a limited number of tokens. When you reach it, Screenbird asks you to revoke one first.

Connected apps

Apps that you connect with a Screenbird sign-in, instead of a token, show up in their own card Connected apps on the same page. Click Disconnect to remove one.

Build your own connection

Screenbird has a public API. Send your token as a bearer token with each request. The full description of the API, with all requests and the rights each one needs, is at api.screenbird.app/v1/openapi.json.

© screenbird.app