lekkin

Help / Developers

Creating an integration and its keys

DevelopersClub admins, and anyone with the Developer role3 min read

An integration is one thing you connect, like your website. It has permissions, which say what it may do, and keys, which your system sends with every call.

Making one

  1. Open Connect (the Integrations tab) and press Add an integration, the round + button at the bottom right.
  2. Give it a name your club will recognise, like “Club website”.
  3. Tick what it may do. Only tick what it needs: a fixtures page needs Fixtures and results, and nothing that changes anything.

You can only give an integration something you’re allowed to do yourself.

Change it later with Change on its card. Removing a permission takes effect on the next call.

Issuing a key

On the integration’s card, press New key and give the key a name, like “Live server”. The key is shown once: copy it into your system then. It isn’t stored anywhere you can see it again, so if it’s lost, issue a new one and revoke the old.

Your system sends it with every call, as Authorization: Bearer <key>.

Keys made on the Sandbox side are test keys and only work in the sandbox. Keys made on Live only work on your real club.

Two-factor for live

Giving an integration access to your real club needs two-factor sign-in or a passkey on your own account: issuing a live key, changing a live integration’s permissions, and adding a live webhook. If you’re asked for it, the message links to your account page, where you can turn it on. The sandbox doesn’t ask.

Revoking a key

Press Revoke beside a key. It stops working at once. Give each server or person their own key, so you can revoke one without breaking the rest.

Still stuck? Tell us what you were trying to do.