Ticketing Systems

TestRail

Connect TestRail to Ploy to see everyone in your TestRail instance, the role each person holds, and which groups they belong to. Ploy matches TestRail users to your existing Ploy identities by email and surfaces, for every user, their name, email, whether their account is active, their role (such as Lead or Tester), and their group memberships.

Once connected, Ploy can also provision access in TestRail from your automated flows: create new users, deactivate users who are leaving, and add or remove people from groups.

Before you begin

You need a TestRail account with administrator access, and the API key you use must belong to that administrator. Administrator access is required so Ploy can list every user in the instance and manage users and groups. Group features require TestRail 7.5 or later.

Enable the TestRail API

  1. Sign in to TestRail as an administrator.

  2. Go to Administration > Site Settings > API.

  3. Turn on Enable API and save.

Generate an API key

  1. Click your name in the top-right corner and choose My Settings.

  2. Open the API Keys section.

  3. Click Add Key, give it a name (for example, "Ploy"), and generate it.

  4. Copy the key and keep it somewhere secure, such as a password manager. You will paste it into Ploy in the next step.

Connect TestRail in Ploy

  1. Open the TestRail integration in Ploy.

  2. In TestRail Subdomain, enter your subdomain — the part before .testrail.io. For example, enter company for company.testrail.io.

  3. In Administrator Email, enter the email address of the administrator the API key belongs to.

  4. In API Key, paste the key you generated.

  5. Click Test to check the connection. Ploy verifies the credentials against your TestRail account.

  6. When the test succeeds, click Save. Ploy will begin scanning your TestRail users on its regular schedule.

What each field is for

  • TestRail Subdomain: identifies which TestRail instance Ploy connects to.

  • Administrator Email: the administrator account the API key belongs to, used together with the key to authenticate.

  • API Key: lets Ploy authenticate to the TestRail API for this connection. It is stored encrypted and is not shown again after you save.

What Ploy imports

  • Users — every user in your TestRail instance, matched to your Ploy identities by email, with their name, email, and active status.

  • Roles — the role each user holds, such as Lead or Tester.

  • Groups — your TestRail groups and who belongs to each one.

Ploy refreshes this data automatically on a recurring schedule. TestRail does not expose a last-login or last-active time through its API, so Ploy does not show TestRail activity dates.

Provisioning access from Ploy

With the administrator API key in place, Ploy flows can make changes in TestRail:

  • Create a user — add a new TestRail user by name and email.

  • Deactivate a user — TestRail has no permanent delete, so Ploy deactivates the account, which frees the licence seat.

  • Manage group membership — add or remove a user from a TestRail group.

Troubleshooting

  • The connection test fails with "Invalid email or API key". Check the administrator email and make sure the API key was copied in full with no extra spaces.

  • The test reports the key is not an administrator key. The API key must belong to a TestRail administrator. Generate the key while signed in as an administrator.

  • The connection fails to reach TestRail. Confirm the API is enabled under Administration > Site Settings > API, and that the subdomain is correct.

  • A user is missing from Ploy. Ploy lists the users your administrator account can see in TestRail. Confirm the person has a TestRail account.

Was this helpful?
Was this helpful?