Skip to main content

API keys

API Keys in Wallboard allow you to authenticate and access specific Wallboard API functions from external systems. You can manage your API keys through Settings > Integrations > API Keys.

Each API key has a specific scope that determines what actions it can perform, and can be enabled or disabled as needed.

Accessing API Keys​

Navigate to Settings > Integration > API Keys to view and manage your API keys.

API Keys List View​

The main interface displays all API keys in a table format with the following columns:

  • Enabled Status: Visual indicator showing whether the API key is active
  • Name: User-defined name for the API key
  • Scope: The functionality assigned to this key
  • Created At: When the API key was originally created

Available Actions​

For each API key in the list, you can:

  • Edit: Modify the name and enabled status
  • View API Key: Display the full API key value (unmasked)
  • Copy: Copy the API key value to your clipboard
  • Delete: Remove the API key permanently

Creating a New API Key​

  1. Click the "Add API Key" button in the API Keys header
  2. Fill out the required fields:
    • Name: Descriptive name for your API key
    • Enabled Status: Toggle to enable/disable (defaults to enabled)
    • Scope: Select one permission scope (see below)
  3. Save to create the API key
  4. The new API key will appear in your list and be ready for use

API Key Scopes​

Each API key must have exactly one scope that determines its permissions:

  • Webhook API Call
  • Proof of Play Read
  • Internal Datasource Write

Managing Existing API Keys​

Editing API Keys​

You can modify existing API keys by clicking the Edit action:

Editable Fields:

  • Name: Change the descriptive name
  • Enabled Status: Enable or disable the key

Non-Editable Fields:

  • Scope: Cannot be changed after creation (create a new key if different scope needed)

Viewing API Key Values​

  • Click "View API Key" to see the complete, unmasked API key value
  • Click "Copy" to copy the API key to your clipboard for use in integrations

Enabling/Disabling API Keys​

  • The Enabled Status column shows a visual indicator of each key's state
  • Use the Edit function to toggle a key between enabled and disabled
  • Disabled keys will not authenticate API requests

Deleting API Keys​

Click the Delete action to permanently remove an API key.

danger

Once deleted, any systems using this API key will lose access. Make sure to update your integrations before deleting active keys.

Last updated on