Within the Teamwork.com Developer Portal, you can create new apps leveraging the Teamwork.com API.

Before you start

You must first set up your publisher details before you can start creating apps in the Teamwork.com Developer Portal.

Create an app

Once your publisher details are saved, welcome landing page is displayed when you access the Developer Portal.

  1. Navigate to your Developer Portal: https://{yourTeamwork.comURL}.com/developer.
  2. Click Create Your First App.


     
  3. Fill out the app details:
    1. Name: The name of your app which will show on your app's consent screen.
    2. Icon: Shown to users during authentication and installation.
    3. Description / Short description: Outline what the app will do.
    4. Product(s): Which Teamwork.com product(s) your app intends to use.
      📝 You must select at least one Teamwork.com product. You can update this in the future, however adding new products requires you to re-authenticate to access APIs under the new scopes.
    5. Redirect URIs: Your app's return URI. 
      📝 You must enter at least one URI.


  4. Click Create App.

Once created, the app is listed in your Apps list within the Developer Portal.


View, manage, and verify an app

  1. Navigate to your Developer Portal: https://{yourTeamwork.comURL}.com/developer.
  2. Click an app to open the app details view.



While viewing the app, you can access the associated data you need to get started. The app screen is split into two main tabs: General and Credentials.
 

General

The General tab documents the app's main details:

  • Name – app name entered on creation.
  • Owner – app creator's name.
  • Icon – icon shown to users during authentication and installation.
  • URL – link to public page about your app.
  • Description – your public app description.
  • Short description - public short description for the app.

Image Placeholder

Credentials

The Credentials tab provides all of the data needed in order to authenticate using the Teamwork.com app login flow. You can manage your scopes and add new redirect URIs here.

  • Client ID – unique ID for authentication passed in the client_id parameter.
  • Client secret – authentication secret passed under client_secret parameter.
  • Products – which products’ data your app needs to access.
  • Redirect URIs – list of allowed URIs to redirect to when authentication is complete or has failed.
    📝 These must be secure URIs with https only (unless they are using localhost) or it will return an error.
  • Origins – Optional list of origins allowed to complete the authentication flow.

Image Placeholder


'In development' app status

The 'In development' tag means your app is currently in development mode and can only be used by the Teamwork.com account it was created under.

Once you are ready to publish your app and make it available to all Teamwork.com users, read our app verification documentation. This will to help you speed up the verification process, getting your app approved on the first review.


For more information, see: Getting Your App Verified