GitHub (Cloud)

Use GitHub Apps for organization installs. OAuth can be used for user-scoped access when required.

Create the GitHub App

1. In GitHub, go to Settings → Developer settings → GitHub Apps → New GitHub App.
2. Set the Homepage URL to your tenant app URL.
3. Configure the GitHub App URLs. The Redirect base URL is where users are sent after successful authorization (typically your tenant app URL):
   • Webhook URL: {{endpoint}}/webhooks/github
   • Callback URL: {{endpoint}}/auth/github/callback
4. Enable Webhook → Active and set a webhook secret.
5. Grant required permissions:
   • Repository metadata: Read
   • Pull requests: Read & write
   • Contents: Read
6. Subscribe to events you plan to route (Pull request, Push, Check suite).
7. Generate and download the private key (.pem). Copy the App ID, Client ID, and Client Secret.

Register the provider in Relaymesh (SaaS UI)

1. Open Providers in the Relaymesh dashboard.
2. Click Add provider → GitHub.
3. Paste App ID, App slug, Client ID, Client Secret, and Webhook secret.
4. Save to generate the onboarding URL.

Register via CLI

relaymesh --endpoint https://api.your-domain.com providers create --provider github --config-file github.yaml

webhook:
  secret: ${GITHUB_WEBHOOK_SECRET}
app:
  app_id: 12345
  app_slug: your-app-slug
  private_key_path: ./github.pem
oauth:
  client_id: ${GITHUB_CLIENT_ID}
  client_secret: ${GITHUB_CLIENT_SECRET}

Onboarding

Copy the onboarding URL from the dashboard and install the app on the target org or user account.

After installation, you should see the GitHub installation under your workspace. Relaymesh Cloud registers webhooks automatically during onboarding.

Onboarding URL format

{{endpoint}}/?provider=github&instance={{provider_hash}}&tenant_id={{tenant_id}}&state={{optional_correlation}}

tenant_id is optional for single-tenant usage. state is optional and can be used for correlation.