Secret key pairs in Rival are secure storage entries that hold credentials, tokens, or identifiers needed to connect your research domain to external systems (e.g., BHN, CRM tools, APIs).
They allow scripts and integrations to authenticate securely without exposing sensitive data in plain text.
Key benefits:
Security – Credentials are encrypted and never displayed in logs.
Reusability – Saved keys can be referenced in multiple scripts using Handlebars notation:
{{{secrets.secret_label}}}
For detailed steps on making secure API calls to external systems from Rival scripts using these secrets, check out the detailed guide
Centralized Management – Update credentials in one place instead of changing every script.
⚠️ Important: Secret labels are case-sensitive and must exactly match how they are referenced in scripts.
Where to Manage Secret Key Pairs
Secret key pairs can only be managed by Research Domain Admins.
Go to the Settings tab in the top header.
From the left navigation, select Platforms.
Open the Secret Key Pairs tab.
Adding a Secret Key Pair
In the Secret Key Pairs tab, click the ➕ Action button.
Enter:
Label – The name you’ll use to reference this secret in scripts (case-sensitive).
Secret Value – The credential/token you want to store.
Click Save.
Editing a Secret Key Pair
You can update the secret value, but not the label.
To update:
Find the secret key pair in the list.
Click the pencil icon next to the secret.
Change the Secret Value.
Click Save.
Deleting a Secret Key Pair
Find the secret to remove.
Click the Delete (trash) icon.
Confirm deletion.
⚠️ Deleting a secret breaks any script that references it. Update or remove those script references before deletion.