Endpoint called by GitHub post-installation.

curl --request GET \
  --url https://api.example.com/api/v0/companies/github/installation-callback

{
  "msg": "<string>"
}

Companies

Endpoint called by GitHub post-installation.

Handles two flows:

setup_action=install: The installation was completed. Registers the installation and redirects to the success page.
setup_action=request: The installation was requested but awaits org owner approval. Stores the requester’s GitHub user ID (for webhook matching) and redirects to the pending page.

Access control rules

Company member of the company.
Admins can list all companies. Requires manage_companies permissions.

GET

api

companies

github

installation-callback

Endpoint called by GitHub post-installation.

curl --request GET \
  --url https://api.example.com/api/v0/companies/github/installation-callback

{
  "msg": "<string>"
}

Query Parameters

installation_id

integer<int64> | null

The installation id, unique to an installation of the GitHub app. Present for install, absent for request.

Required range: x >= 0

code

string | null

The code to create a user access token. May be absent for request.

setup_action

string

required

The type of callback. Either "install" or "request".

state

string | null

The CSRF state that was set at the start of the installation. Absent when the org admin approves a requested installation (they never went through our installation link flow).

Response

GitHub app installed or installation pending approval

Returns the GitHub App installation link.Endpoint to list the GitHub organizations the Cantina App has been installed in.

⌘I

Documentation Index

Query Parameters

Response