Skip to documentation
SmartLinks Help Center
Step-by-step product guides Read as Markdown ↗
Free to read. Private to operate. These guides never display account data or keys. Using a feature requires your own account, permissions and applicable plan. YOUR_API_KEY is only a placeholder.

API keys and SDK setup

Keys authorize integrations. Public documentation shows only placeholders; actual keys remain in your private account.

Before you start

Use an account with key-management permission and select the intended app. Decide the minimum scope the integration requires.

Step by step

  1. Open the app's API Keys, or account-level Manage → API Keys.
  2. Create a key using the name, app assignment and scope controls available to your account.
  3. Limit the key to the intended app and required operations. Keep administrative or multi-app keys out of distributed client apps.
  4. Copy the key only into your own private development configuration.
  5. Follow the platform's SDK installation guide and replace YOUR_API_KEY locally.
  6. Send a non-sensitive test event and confirm it under the correct app.
  7. If changing or revoking a key, identify dependent integrations first, deploy the replacement and verify them before disabling the old key.

Confirm it worked

Only the intended integration can access its allowed app/resources, and a known test operation succeeds. A created key alone is not SDK integration.

Troubleshooting

A 401 can indicate a missing, inactive or invalid key. A scope/permission failure can require a different authorized operation, not broader access by default. A mobile app key can be extracted from its binary; never use it to hold server, store or provider secrets.

Related: API keys and security, API Explorer.

Browse all product guides → · SDK installation guides