Skip to main content
POST
Rotate webhook secret

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

modelId
string<uuid>
required

The unique identifier of the shared model.

Response

Webhook secret rotated successfully. The response includes the new webhook secret.

authMethod
enum<string>
required

Authentication method. "ssh" for deploy key, "https_token" for deploy token/PAT, "github_app" for a GitHub App installation.

Available options:
ssh,
https_token,
github_app
Example:

"ssh"

baseBranch
string
required

The target branch for Omni pull requests

Example:

"main"

branchPerPullRequest
boolean
required

If true, all pull requests will create a branch in Omni

Example:

false

cloneUrl
string
required

Clone URL of the git repository (SSH or HTTPS)

Example:

"git@github.com:org/repo.git"

commitSigningCommitterEmail
string | null
required

Committer email written into signed commits (github_app auth). Null when signing is not configured.

Example:

"omni-bot@example.com"

commitSigningCommitterName
string | null
required

Committer display name written into signed commits (github_app auth). Null when signing is not configured.

Example:

"Omni Bot"

commitSigningPublicKey
string | null
required

SSHSIG signing public key to register on the committer's GitHub user (github_app auth). Null for other auth methods.

Example:

"ssh-ed25519 AAAA..."

gitFollower
boolean
required

If true, the shared model is read-only and can only be updated by merging pull requests to the base branch

Example:

false

gitServiceProvider
string
required

The git provider type

Example:

"github"

githubAppInstallationId
string | null
required

GitHub App installation ID. Null unless github_app auth.

Example:

"12345678"

modelPath
string | null
required

Path to model files in the repository

Example:

"omni/my_model"

publicKey
string | null
required

SSH public key for repository access (deploy key). Null for HTTPS token auth.

Example:

"ssh-ed25519 AAAA..."

requirePullRequest
enum<string>
required

When pull requests are required: always for all changes, users-only for user-initiated changes only, never for direct commits.

Available options:
always,
users-only,
never
Example:

"users-only"

sshUrl
string
required
deprecated

Deprecated — use cloneUrl. Clone URL of the git repository.

webUrl
string | null
required

Custom web URL for the git repository, or null if not set

Example:

"https://github.com/org/repo"

webhookSecret
string
required

The new webhook secret. Returned only here — read it back later with GET /git?include=webhookSecret.

webhookUrl
string
required

Webhook URL to configure in your git provider

Example:

"https://app.omni.co/api/webhooks/model/..."