How to use Secret Keys in Workflows
Secret Keys allow you to securely store sensitive information like API keys, passwords, and tokens. This feature ensures your credentials remain protected while being easily accessible for automation tasks.
This feature is available for certain blocks:
For the purpose of this guide, we'll use Send API Request as an example. We will create a Secret Key to store our API authorization private key, configure permissions, use it in our Send API Request action, and manage all created keys.
Follow these steps:
Access the Secret Key creation: In a Send API Request block when adding a Secret Key into your authorization header, click the "+" sign next to the value field.
Hover over "Insert a Secret Key": In the dropdown menu that appears, hover over the "Insert a Secret Key" option.
Click "Create Secret Key": Select "Create Secret Key" from the submenu to create a new Secret Key.
Fill in your Key Name: Enter a descriptive name for your Secret Key (e.g., "API Key" or "Password"). This name will help you identify the key later.
Fill in your Secret Key Value: Enter the actual secret value (typically a private API key, password, or token) that you want to store securely. Then click "Create Secret Key".
Adjust the access type: After creating the Secret Key, If needed, change the access type between "Team" and "Restricted" by clicking the dropdown menu in General Access.
"Team": This option allows anyone in your organization to view and access the collection and its contents.
"Restricted": This option limits access to the collection to specific people or groups within your organization.
Add or remove people and groups: If you have selected "Restricted" access, you can add or remove specific people or groups who should have access to the collection. To add people, simply start typing their names or email addresses, and select them from the list. For each person or group you add, you can set granular permissions by selecting either "Can edit" or "Can view" to control their level of access to the collection.
Manage Secret Keys: Hover over "Insert a Secret Key" and click "Manage Secret Keys" to view all created keys. Use the filter tabs ("All", "Team", "Private", and "Private (Admin View)") to display keys based on their access permissions. Click the ellipsis icon next to any key to access options for updating permissions, renaming the key, editing its value, or deleting it.
Use the Secret Key: You can now use this Secret Key like any other variable in your Workflow. It will appear in the variable selector under the "Insert a Secret Key" section.
Add Secret Keys to other actions: You can add these Secret Keys to both the Send API Request and Run Code actions wherever secure authentication is needed.
Secret Keys are stored securely and their values are never displayed in plain text after creation. Only users with proper permissions can access and use them.
When you successfully configure a Secret Key, it will appear as a masked variable in your Workflow, ensuring your sensitive information remains protected while still being accessible to your automation processes.