SaaS

TeamRetro

Connect TeamRetro to Ploy to see every user in your TeamRetro account, their account role, whether they are suspended, and which teams they belong to. Ploy can also add people to the account, suspend and reactivate them, change their account role, remove them, and add or remove them from teams.

This integration is in beta

The TeamRetro integration is in beta. It was built from TeamRetro's API documentation and has not yet been checked against a live TeamRetro account, so some details may need adjusting once customers connect it. Beta does not limit what the integration can do.

The first step of setup is a consent checkbox. Ticking it lets Ploy capture redacted error data when a request to TeamRetro fails: the error response TeamRetro sends back, with personal details, keys and other secrets removed. Ploy uses it only to fix problems with this integration. You must tick the box to continue.

What Ploy reads

  • Every user in your TeamRetro account, with their name and email address

  • Each user's account role: Organization admin or Member

  • Whether each user is active or suspended

  • Every team, and the members of each team, including who is a team admin

Ploy does not read your retrospectives, health checks, actions or agreements.

Before you start

  • Ploy needs an account API key. Account keys are not available on every TeamRetro plan; if you cannot create one, ask TeamRetro about your plan.

  • You need to be the Account Owner in TeamRetro to create an account API key.

  • Know which region your account is hosted in: the United States (the default) or the European Union.

  • A team API key will not work: it cannot read the account's user directory.

Create an account API key in TeamRetro

  1. Sign in to TeamRetro as the Account Owner.

  2. Open Account, then Settings, then API & Connected Apps.

  3. Create an API key with Read and Write access. Read is enough for scanning; Write lets Ploy add, suspend, remove and change people.

  4. Copy the key. It starts with tra_. Treat it like a password.

Connect TeamRetro in Ploy

  1. In Ploy, open Integrations and choose TeamRetro.

  2. Tick the beta consent checkbox.

  3. Select your TeamRetro region.

  4. Paste the account API key.

  5. Click Test. Ploy reads your TeamRetro users to check the key and region work.

  6. Finish the setup. The first scan starts straight away.

Things to know

  • TeamRetro identifies people by email address. If someone's email changes in TeamRetro, Ploy sees them as a new user.

  • People added from Ploy join as members with no teams. Add them to a team from the team's page in Ploy.

  • Ploy only adds existing account users to teams. Add the person to the account first.

  • TeamRetro does not let an API key suspend the Account Owner.

  • Team admin rights given through SCIM cannot be changed through the API.

  • TeamRetro allows 60 API requests a minute per key, so a large account's first scan can take a few minutes.

  • If you revoke the API key in TeamRetro, create a new one and update it in the TeamRetro connection in Ploy.

Was this helpful?
Was this helpful?