Overview
When connecting TrackVia to external systems via Workato, following a consistent set of practices ensures your integrations stay reliable, secure, and easy to maintain over time. This article covers the key practices for configuring and managing TrackVia Connections in Workato, including how to set up dedicated API users, apply the right permissions, test connections, and keep credentials healthy.
For a general introduction to what Connections are and how they fit into the Workato platform, see Introduction to TrackVia Integrations Powered by Workato.
Jump to Section
- Use Dedicated API Users for Each Integration
- Naming Convention Recommendations
- Configuring Permissions
- Testing and Validating Connections
- Credential Rotation and Maintenance
Use Dedicated API Users for Each Integration
TrackVia recommends creating a dedicated TrackVia user account for each integration rather than reusing employee accounts. Dedicated accounts prevent disruptions when employees leave, make auditing and troubleshooting easier, and keep automated activity clearly separate from manual user updates.
For example, instead of using a personal employee account like john.smith@company.com, create a dedicated integration account such as google.integration@company.com.
Why Dedicated Integration Users Matter
- Prevent outages — if an employee account is deactivated or the password changes, any recipe using it will immediately fail. A dedicated account is never tied to an individual's employment status.
- Improve auditing visibility — activity from integration accounts is easy to distinguish from human activity in logs and record history.
- Simplify troubleshooting — when an issue arises, you can immediately identify which integration is responsible.
- Scope access appropriately — dedicated accounts can be assigned minimal permissions tailored to that integration's specific needs.
Naming Convention Recommendations
Name each integration account using the external system as the First Name and "Integration" as the Last Name. This makes integration accounts immediately identifiable in the TrackVia user list.
| First Name | Last Name | Example Email |
|---|---|---|
| Google Sheets | Integration | googlesheets.integration@company.com |
| Salesforce | Integration | salesforce.integration@company.com |
| Workday | Integration | workday.integration@company.com |
Use a shared mailbox or distribution list for the account email address where possible, so that password reset emails and notifications are accessible to your team rather than a single individual.
Configuring Permissions
Each dedicated integration account must be configured as an API User in TrackVia and assigned a role scoped to only the resources that integration requires.
Setting Up the API User
- In TrackVia, navigate to the Users section of the Admin panel
- Create a new user using the naming convention above
- Check the Set as API User checkbox on the user profile
- Save the user — an API Key and Auth Token will be generated for this account
Assigning a Limited Role
Assigning a broad or admin-level role to an integration account is a security risk. If the account credentials are ever compromised, a limited role contains the blast radius. To configure the role:
- Create a new Role in TrackVia specifically for this integration (e.g., "Salesforce Integration Role")
- Edit the role permissions to allow access only to the tables, views, and operations the integration requires
- Assign that role to the integration user account
For step-by-step instructions on creating and configuring roles, see How to Create a Role to Assign Permissions.
⚠ Note: If the integration account is missing the required table or operation permissions, Workato will return a 403 Forbidden error. If you encounter this, review the role assigned to the integration user and confirm all required permissions are enabled.
Testing and Validating Connections
After creating a Connection in Workato, always verify it is working before building recipes that depend on it.
How to Test a Connection
- Open the Connection in Workato
- Click the Test Connection button
- A green success indicator confirms Workato can authenticate and communicate with TrackVia
- A red failure indicator means authentication failed — review the Access Token, UserKey, and API User status in TrackVia
Common Reasons a Connection Test Fails
- The API User is inactive or has been deactivated in TrackVia
- The Access Token has expired or been regenerated without updating the Connection
- Sandbox credentials are being used against a production environment (or vice versa)
- The UserKey entered does not match the environment
For detailed troubleshooting steps by error type, see Troubleshooting Common API Errors.
Credential Rotation and Maintenance
Connections require ongoing maintenance to stay healthy. Stale or unmonitored credentials are a common cause of unexpected integration failures.
Rotating Credentials
When you regenerate an API Key or Auth Token in TrackVia, the existing token is immediately invalidated. Any active Workato recipes using that Connection will begin failing with a 401 Unauthorized error until the Connection is updated. To rotate credentials safely:
- Identify all recipes that use the Connection you are rotating
- Stop those recipes before regenerating the token
- Regenerate the Access Token in TrackVia
- Update the Workato Connection with the new credentials and test the Connection
- Restart your recipes
Ongoing Maintenance Tips
- Rotate tokens on a regular schedule as part of your security practice
- Monitor integration accounts to ensure they remain active — a deactivated account will cause all dependent recipes to fail
- Keep a record of which Workato recipes depend on each Connection, so credential changes can be managed without missed updates
- If your organization uses multiple environments (sandbox and production), maintain separate dedicated accounts and connections for each
Related Articles
- Introduction to TrackVia Integrations Powered by Workato — Read this first for an overview of Connectors, Connections, Recipes, and core platform concepts.
- Workato Recipe Design Best Practices — Read this after setting up your Connections to learn how to build reliable, well-structured Recipes.
- How to Restart Workato Recipes After Reaching the Task Limit — Read this if your Recipes stop running unexpectedly due to task limit restrictions.
- How to Create a Role to Assign Permissions — Read this for step-by-step instructions on creating and configuring the limited role for your integration account.
- Troubleshooting Common API Errors — Read this if your Connection test fails or your recipes are returning authentication or permission errors.
Comments
0 comments
Please sign in to leave a comment.