App details

Read an app's description, lifecycle and Builder, manage Team access and issue the app's API key.

For: Anyone who can see the app; management sections for its Builder · Last updated

Select Details on an app's card to open its page. It shows the app's name and phase, then its description and "Built by" followed by its Builder.

Sections#

  • Deployment shows how to clone the app's code and, while the app is running, Open App. Otherwise it says "No deployment configured." (or "Retired — no longer running." for a retired app). See Deploying your code and Opening an app.
  • Who can see it describes who can reach the app in its current phase.
  • Lifecycle lists each phase the app has been in, with its start and end dates ("now" for the current phase) and any note.
  • Record shows the Builder and the size of the current Cohort.

Who can manage an app#

You see the management controls on this page if you are the app's Builder, hold the manage_apps ability, or are an administrator. They are the Lifecycle buttons, the API Key card and the editable Team access card. See Advancing and retiring an app for the lifecycle buttons. Once an app is retired, the lifecycle buttons no longer appear.

Team access#

Once an app is Full-Time, a Team access card appears.

  • By default everyone in the company can see the app. The card says "Open to everyone." to people who cannot manage the app.
  • If you can manage the app, the card says "Everyone in the company can see" the app's name "unless you scope it to one or more Teams below." Tick the Teams that should have access; Save and Cancel appear once you change a selection. Select Save, and "✓ Saved" confirms it. Clear every Team to open the app to everyone again.
  • If your company has no Teams, the card says that no Teams exist.

When Teams are selected, only members of those Teams, the Builder, administrators and people with the manage_apps ability can see the app.

API key#

The API Key card is shown to people who can manage the app. It gives the app its own key, bound to the app and not to a person, so the app can sign in to the platform on its own.

  1. Select Issue API key.
  2. The key appears once, with the warning "This is the only time this key will be shown. Copy it now — it cannot be retrieved again." Select Copy, store the key somewhere safe, then select Done.

Afterwards the card shows the key's label and "Issued" date. To replace it, select Rotate key… and confirm Rotate key in the dialog "Rotate this App's API key?". The current key stops working immediately, anything deployed with it needs the new one, and the new key is shown once.