Nova Admin Docs
Integrations

GitHub

How to create a GitHub App and connect it to Nova Admin.

Create a GitHub App, install it on your organization, then enter the credentials below.

Prerequisites

  • GitHub organization or personal account with permission to create GitHub Apps.
  • Nova Admin callback URL (shown in the connect dialog under Inbound Webhook).

Steps

  1. Go to <strong>github.com/settings/apps</strong> (or your org's Developer settings) and click <strong>New GitHub App</strong>
  2. Set <strong>App name</strong> (e.g., "Nova Admin") and <strong>Homepage URL</strong> to your Nova Admin instance URL (e.g., <code>https://nova-os.netlify.app&lt;/code>)
  3. Under <strong>Webhook</strong>, check "Active" and set the <strong>Webhook URL</strong> to the URL shown in the <strong>Inbound Webhook</strong> section above (create one first if needed)
  4. Set the <strong>Webhook secret</strong> to the same value you enter in the <strong>Webhook Secret</strong> field above — use the secret from the Inbound Webhook section, or generate one with <code>openssl rand -hex 32</code> and paste it in both places
  5. Under <strong>Permissions → Repository</strong>: set Contents, Issues, Pull requests, Actions to <strong>Read & Write</strong> and Metadata to <strong>Read-only</strong>
  6. Under <strong>Subscribe to events</strong>: check <strong>push</strong>, <strong>pull_request</strong>, <strong>issues</strong>, <strong>issue_comment</strong>, <strong>pull_request_review</strong>, <strong>check_run</strong>
  7. Click <strong>Create GitHub App</strong> — note the <strong>App ID</strong> shown on the next page
  8. Click <strong>Generate a private key</strong> — download the <code>.pem</code> file and paste its full contents (including BEGIN/END lines) into the Private Key field above
  9. <strong>Install the App</strong>: go to the App's Install page → select your org → choose "All repositories" or specific repos → click Install. The <strong>Installation ID</strong> is the number in the URL (e.g., <code>github.com/settings/installations/<strong>12345678</strong></code>)
  10. Enter the App ID, private key contents, and Installation ID in the credentials section, then click <strong>Connect GitHub</strong>

Credential fields

FieldRequiredNotes
GitHub App IDYes123456
GitHub App Private KeyYesSecret — stored encrypted.
GitHub App Installation IDYes12345678
Webhook SecretNoSecret — stored encrypted.

Troubleshooting

  • 401 Unauthorized: verify the App ID, Installation ID, and private key match the installed GitHub App.
  • Missing permissions: check the GitHub App's repository and organization permissions match what the actions require.
  • Need help?: refer to the GitHub Apps documentation.

On this page