Before you start
You need project administrator access. Store server integration keys in your secret store and keep them out of participant code.
Open: Your project → Project Settings → API keys.
Steps
- Choose Create API key and enter a meaningful Key name.
- Under Use this key for, select Server integration, Custom JavaScript lookup (read-only) or Signed-in respondent’s own answers.
- Select the required Permissions. For browser lookups, enter the permitted survey group and question IDs. For server authoring, use a separate project-wide key.
- Choose an expiry date or Never expires, then Create key. Copy the secret once and choose Done when it is safely stored.
- Use Edit key to change the name, expiry or allowed access. Use Revoke key to stop authentication immediately.
- Open Retired to find revoked or expired keys. Use Remove from list to clear a retired key from the management list while retaining its audit history.
Check the result
The Active view contains current keys. Secrets are displayed once; editing a key does not reveal its original secret.
Troubleshooting
A key stops working when expired or revoked, or when its creator loses the required project role. If the secret is lost, issue a replacement with equivalent access and revoke the old key after switching the integration.