Docs

validateIntegrationUpdate

Perform a validation of an integration update request

PUT/v1/admin/integrations/{id}/validate

Authorization

AuthorizationBearer
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-workspace-idstring
Workspace ID
x-multiple-integrations?string
Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Path parameters

idstring
Integration Version ID

Request body

Integration

configuration?object
Default configuration definition of the integration
configurations?object
Additional configuration definitions of the integration
extraOperations?object
**EXPERIMENTAL** extra integration operations enabled for this integration. Keys map to operation names. A value of `null` or `{ enabled: false }` removes the operation; `{ enabled: true }` enables it. Operations that are not provided are left unchanged.
sdkVersion?string
(max length: 200)
channels?object
maxExecutionTime?integer
Maximum execution time of the integration (in seconds).
identifier?object
actions?object
events?object
states?object
user?object
entities?object
interfaces?object
attributes?object
Optional key-value attributes. Set attributes to null to remove them
secrets?object
Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
code?string
JavaScript code of the integration
icon?string
Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
readme?string
Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.
title?string
Title of the integration. This is the name that will be displayed in the UI(min length: 1, max length: 64)
description?string
Description of the integration. This is the description that will be displayed in the UI(max length: 256)
url?string | null
URL of the integration
public?booleandeprecated
[DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
visibility?enum<string>
The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
Available options:"public","private","unlisted"
layers?string[]

Response

Validation succeeded: the integration can be updated using the same parameters