Sign in
Content

Create a GitHub integration

Checks that the repository can be read (a personal access token is required for private repositories), connects it, and enables changelog generation for it; blog post and X post outputs start disabled. A webhook secret is generated on creation. Copy the payload URL and secret from the dashboard to receive push and release events.

post/v1/integrations/github

Request body

ownerstring required

GitHub user or organization that owns the repository.

repostring required

Repository name without the owner.

branchstring nullable

Branch to read activity from. Defaults to the repository's default branch.

tokenstring nullable

GitHub personal access token with read access to the repository. Required for private repositories; public repositories work without one.

Example request

{
  "owner": "usenotra",
  "repo": "notra",
  "branch": "main",
  "token": "github_pat_11ABCDEFG..."
}

Response

GitHub integration created successfully

Changes