OMomni
Model Git configuration

Rotate webhook secret

Changed on
<Note> This endpoint requires Modeler permissions or higher. </Note>

Rotate the pull request webhook signing secret for the Git configuration of a shared model, or a shared extension model in the Develop independently branch workflow, and return the updated Git configuration with the new secret. The previous secret stops validating webhook deliveries immediately.

If the git repository is shared across multiple models, the secret belongs to whichever model owns the shared configuration. Rotating the secret for any of the sharing models rotates the one shared secret for all of them.

This is the only endpoint that returns the new secret value. Call GET /v1/models/{modelId}/git?include=webhookSecret to retrieve it after the rotation, if needed.

post/v1/models/{modelId}/git/rotate-webhook-secret

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/models/{modelId}/git/rotate-webhook-secret
  • Auth
    HTTP bearer

Path parameters

modelIdstring uuid required

The unique identifier of the shared model, or a shared extension model in the Develop independently branch workflow.

Response

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

authMethod'ssh' | 'https_token' | 'github_app' required

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

baseBranchstring required

The target branch for Omni pull requests

branchPerPullRequestboolean required

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

cloneUrlstring required

Clone URL of the git repository (SSH or HTTPS)

commitSigningCommitterEmailstring nullable required

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

commitSigningCommitterNamestring nullable required

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

commitSigningPublicKeystring nullable required

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

gitFollowerboolean required

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

gitServiceProviderstring required

The git provider type

githubAppInstallationIdstring nullable required

GitHub App installation ID. Null unless github_app auth.

modelPathstring nullable required

Path to model files in the repository

publicKeystring nullable required

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

requirePullRequest'always' | 'users-only' | 'never' required

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

sshUrlstring required

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

webUrlstring nullable required

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

webhookSecretstring required

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

webhookUrlstring required

Webhook URL to configure in your git provider

Example response

{
  "authMethod": "ssh",
  "baseBranch": "main",
  "cloneUrl": "git@github.com:org/repo.git",
  "commitSigningCommitterEmail": "omni-bot@example.com",
  "commitSigningCommitterName": "Omni Bot",
  "commitSigningPublicKey": "ssh-ed25519 AAAA...",
  "gitServiceProvider": "github",
  "githubAppInstallationId": "12345678",
  "modelPath": "omni/my_model",
  "publicKey": "ssh-ed25519 AAAA...",
  "requirePullRequest": "users-only",
  "webUrl": "https://github.com/org/repo",
  "webhookUrl": "https://app.omni.co/api/webhooks/model/..."
}

Changes