Github App Setup Callback — POST /api/v1/github/app/setup-callback
Github App Setup Callback
Record the installation GitHub sent back, for the project the signed state names.
Endpoint: POST /api/v1/github/app/setup-callback
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”| Content type | Body | Required |
|---|---|---|
application/json | GitHubAppSetupCallback | yes |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | GitHubAppSetupResult (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
403, with the message “QA lead or administrator only”409, with the message “Save the project’s GitHub repository on Settings › GitHub first, then install the App”
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: GitHub App
- Operation ID:
github_app_setup_callback_api_v1_github_app_setup_callback_post - Source code:
backend/app/routers/github_app.py, line 168 - Specification: OpenAPI JSON