Register an app for a team

Path parameters

• team_idstringRequired
  Pattern ^team_[0-9a-f]{32}$

Request body

• namestringRequired
  2–80 characters
• descriptionstring | null
  Up to 500 characters
• icon_urlstring | null
  An https image URL.
  Up to 512 characters
• ui_originsarray of stringRequired
  https origins (scheme and host, no port or path) the dashboard may frame for the app. Each must be one label of 1-63 characters under the environment's apps domain (https://<app>.ivoraapps.com in production); other hosts are refused (422 app_origin_outside_apps_domain).
• extensionsarray of Extension
  Child attributes

  • pointenumRequired
    Where the dashboard shows the app: a project tab, a panel on a station or a session, an overview widget, or an action (a button on a station or session that opens the app).
    One of project.tab, station.panel, session.panel, overview.widget, action
  • pathstringRequired
    The page on the app's UI origin, starting with /.
    1–200 characters
  • titlestring | null
    The tab, panel or action label; required except for widgets.
    1–60 characters
  • targetenum | null
    For an action: the page it appears on.
    One of station, session
  • sizeenum | null
    For a widget: its size on the overview grid.
    One of 1x1, 2x1, 2x2
• scopesarray of stringRequired
  Project scopes. Never billing:refund or stations:admin, and never staff or API-key routes.
• webhook_urlstring | null
  The https endpoint the app's lifecycle events go to.
  Up to 512 characters
• visibilityenum
  private: only the owning team's projects can install it. first_party: Ivora's own app, installable by every project and shown as made by Ivora; only Ivora administrators set it (403 otherwise).
  One of private, first_party · Default "private"

Returns · 201

• idstringRequired
• team_idstringRequired
• namestringRequired
• descriptionstring | nullRequired
• icon_urlstring | nullRequired
• ui_originsarray of stringRequired
• extensionsarray of objectRequired
• scopesarray of stringRequired
  The scopes the app requests; an install holds the part its installer consented to.
• webhook_urlstring | nullRequired
  Null for a first_party app read from another team's project.
• revisionintegerRequired
  Counts the changes to the app's scopes, origins and extensions. A consent is valid only for the revision it was given on.
• visibilityenumRequired
  private: only the owning team's projects can install it. first_party: Ivora's own app, installable by every project and shown as made by Ivora; only Ivora administrators set it (403 otherwise).
  One of private, first_party
• publisherstring | null
  Ivora for a first_party app, which the dashboard shows as made by Ivora; null: the team that registered it.
• statusenumRequired
  One of active, archived
• checkout_servicebooleanRequired
  Whether Ivora trusts the app's backend to name the driver's IP address (X-Ivora-Driver-Address) on payment creation, so the 30-a-minute per-address limit counts per driver: honoured only on a client_credentials token of an install holding billing:write, never on a session or exchanged token. Only Ivora administrators set it (403 otherwise), on an app that requests billing:write.
• secret_prefixstring | nullRequired
  The client secret's first characters, to recognise it; the secret is shown only when it is created or rotated. Null for a first_party app read from another team's project.
• secret_rotated_atstring | nullRequired
• created_bystring | nullRequired
  Null for a first_party app read from another team's project.
• created_atstringRequired
• updated_atstringRequired
• installsinteger | null
  Active installs, in the team's projects.
• client_secretstringRequired
  Shown once. Keep it on the app's backend; Ivora stores only its hash.
• webhook_secretstring | null
  Shown once, when the app is registered: the key that signs the app's lifecycle events (Ivora-Signature). Null when the client secret is rotated.

Errors