Sign in
Integrations

Start registration of a customer-owned GitHub App

Changed on

Starts guided registration on github.com for a never-connected GitHub integration. Requires a browser session and project management access. Submit manifest as a JSON-encoded form field to registration_url. The callback saves a project credential secret and redirects to the canonical integration page with github_setup=credentials_saved and credential_secret_id (a public secret ID). It does not connect an installation or change launcher settings.

post/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup

Request

  • Base URL: https://api.omnara.com/v1
  • URL: https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup
  • Auth: API key in cookie __Host-omnara_session and API key in header X-Omnara-Csrf

Request body

expected_setup_revisioninteger required
app_namestring

Optional initial GitHub App name suggestion. When omitted, the user chooses a name on GitHub during registration.

organizationstring

GitHub organization login. Omit to register under a personal account.

Response

GitHub setup information verified.

integration_idstring required
setup_revisioninteger required
registration_urlstring uri required
manifestobject required

Server-authored GitHub App manifest. Serialize this object to the manifest form field when posting to registration_url.

expires_atstring date-time required

Changes