Skip to main content
POST
Start an app listing OAuth install

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to begin an app listing OAuth install.

slug
string
required
Required string length: 1 - 255
inputs
Inputs · object

Connect-time inputs collected before the redirect (tenant address, region, or a choice), keyed by input name. Empty for listings that need no inputs.

integration_id
string<uuid> | null

For switch/reconnect only: the existing integration to re-authorize in place. Bound into the OAuth state so the claim mutates only this integration. Omit for new connects.

intent
enum<string> | null

For switch/reconnect only: 'switch' (API-key -> one-click) or 'reconnect' (re-authorize). Must be set together with integration_id.

Available options:
switch,
reconnect

Response

Successful Response

The provider authorize URL to redirect the user to.

authorize_url
string
required