Integrations

Creates or updates a Mesh app definition on a team.

Creates or updates a Mesh app definition on a team.

put/api/v1/integration-definitions

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v1/integration-definitions
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

teamIdstring required

The team ID

Response

Update success

$schemastring

Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform.

typestring required

Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores.

displayNamestring required

Display name used in the UI for the integration.

logoIconUrlstring

URL to the integration's logo icon (larger, used on listing).

badgeIconUrlstring

URL to the integration's badge icon (small, round, used as a badge in the UI).

category'analytics' | 'cdn' | 'classic' | 'commerce' | 'content' | 'comingSoon' | 'data' | 'deprecated' | 'email' | 'framework' | 'search' | 'starters' | 'translation' | 'uniform' | 'ai' | 'unknown'

Category of the integration.

publicboolean
scopesstring[]

List of permissions to access sensitive data or perform certain actions.

identityDelegationboolean

When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user.

integrationIdstring uuid required

Stable id for this integration definition. Required for identity delegation token exchange.

hasAppSecretboolean
baseLocationUrlstring

Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required.

Changes

No recorded changes to this operation across all 1 revision of this API.