Skip to content

GitHub integration

Connect DXDT to GitHub for read-only visibility into repositories, commits, pull requests, Actions runs, and releases — used to correlate deploys and CI activity with incidents. DXDT only reads.

Setup time ~5 minutes
Difficulty Easy

Access required: Any GitHub account with access to the repos you want visibility into

Prerequisites

  • A GitHub account (github.com) or a GitHub Enterprise Server instance.
  • Access to the organizations and repositories you want DXDT to observe.
  • A few minutes to create a personal access token.

Setup

1. Choose a token type

GitHub offers two token types — either works with DXDT:

  • Fine-grained token (recommended): scope it to the specific org/repos and grant read-only permissions.
  • Classic token: simpler but broader. Use the repo scope (or public_repo for public repos only).

2. Create a fine-grained token

Go to GitHub → Settings → Developer settings → Personal access tokens → Fine-grained tokens and click Generate new token.

  • Name it DXDT (read-only) and set an expiry per your policy.
  • Under Resource owner, select the organization (or your account).
  • Under Repository access, choose the specific repositories DXDT should see.
  • Under Repository permissions, grant Read-only to: Contents, Metadata, Pull requests, Issues, and Actions.
  • Click Generate token and copy the value — it is shown only once.

Note

DXDT performs only read operations. Do not grant any write permissions.

3. Note your API base URL (GitHub Enterprise only)

On github.com, leave the Base URL blank. For GitHub Enterprise Server, use your API endpoint, e.g. https://github.acme.com/api/v3.

Configuration fields

Field Where to find it
Token (token) The personal access token you created (fine-grained or classic).
Base URL (base_url) Leave blank for github.com. For Enterprise Server, enter your API base, e.g. https://github.acme.com/api/v3.

Verify the connection

Open the Configuration tab, paste the token, and click Install & Configure. The Live Status panel should show the authenticated user (@login) and a green connected indicator.

Security

Your token is stored encrypted per-tenant and used only for the read-only GitHub operations listed above. Prefer a fine-grained, repo-scoped token with an expiry.

Troubleshooting

401 Unauthorized — invalid or expired token

The token is wrong, expired, or revoked. Generate a new token and paste the full value with no extra whitespace.

404 Not Found on a repo you expect to see

The token doesn't include that repository, or (fine-grained) the org owner hasn't approved it. Add the repository to the token's Repository access, and for org-owned repos ensure the token is approved by an org admin.

Enterprise Server not reachable

The Base URL is wrong. Use the API path /api/v3 on your GHES host, e.g. https://github.acme.com/api/v3, not the web UI URL.


Vendor documentation: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens