Complete a GitHub App installation

post

https://api.revenium.ai/profitstream/v2/api/integration-credentials/github/app/installations

Called with the installation_id, setup_action, state and code from GitHub's setup redirect, or with setup_action 'link', the state and the code from GitHub's sign-in to connect an installation that already exists. The state must be one this caller started, and the code must belong to an owner of the installation's organization, so a forged installation_id cannot connect another organization. Returns pending_approval when an organization owner still has to approve the request, and choose_installation when a link finds several installations, to link again with the one picked.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

teamId

string

Team to read or write, as the team's hashid (the same id as /v2/api/teams/{id}). The caller must belong to it or be able to read it: 403 otherwise, 404 when no such team exists. An API key may only name its own organization. Omit it for the API key's organization, or for a signed-in user the first organization they belong to.

Body Params

installationId

int64 | null

installation_id from GitHub's setup redirect; null when setupAction is 'request', and for 'link' unless the person picked one of several

setupAction

string

setup_action from GitHub's setup redirect: install, update or request; link after GitHub's sign-in

state

string

The state from GitHub's setup redirect, issued by the install-sessions endpoint

code

string | null

code from GitHub's setup redirect, proving the GitHub user can manage the installation; required unless setupAction is 'request'

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Connected, waiting for an organization owner's approval, or several installations to choose from

400Unknown, expired, used or foreign state, or one used up by 3 attempts GitHub refused; a missing code; or an installation that is not this app's, not on an organization, suspended, or not one the GitHub user owns

401Unauthorized

403Forbidden, including read-only users

404No organization for the caller

409The installation is already connected to another Revenium organization, or the team already connects another GitHub organization through the app

422Request understood but could not be processed

429Too Many Requests

500Internal server error

504Gateway Timeout