v3

latestOpenAPI 3.0.02026-07-31278263961.8 KB

Actions

Update action partially

patch/actions/{selector}

Path parameters

selectorstring required

Query parameters

layer'universal' | 'integration' | 'connection'

integrationKeystring

integrationIdstring

connectionIdstring

connectionKeystring

instanceKeystring

Request body

uuidstring

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

keystring

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

namestring

Display name. Optional on create; used to generate key when key is omitted.

descriptionstring

Optional human-readable description.

metaobject

Optional key-value metadata.

integrationIdstring

Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.

integrationUuidstring

UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.

integrationKeystring

Key of the integration; alternative to integrationId. Resolved to integrationId by the API.

parentIdstring

Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.

parentUuidstring

UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.

parentKeystring

Key of the parent element; alternative to parentId. Resolved to parentId by the API.

connectionIdstring

Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.

instanceKeystring

Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.

isUniversalboolean

When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.

externalAppIdstring

Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.

externalAppUuidstring

UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.

externalAppKeystring

Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.

Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.

configobject

Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.

{"stackTrail":"components:schemas:UpdateAction:properties:outputMapping","oasType":"schema","type":"unknown","description":"Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time."}

intentstring

[Experimental] Intent-based instruction for an agent to configure this element.

Response

idstring required

Internal database ID of the element. Assigned by the API; unique per element.

namestring required

Display name. Always present in API responses (filled by API if not set on create).

uuidstring

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

keystring

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

descriptionstring

Optional human-readable description.

metaobject

Optional key-value metadata.

Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.

revisionstring

Opaque revision token; changes on each update. Used for optimistic concurrency.

createdAtstring

ISO date when the element was created.

updatedAtstring

ISO date when the element was last updated.

archivedAtstring

When set, the element is archived (soft-deleted). Archived elements cannot be patched.

isDeactivatedboolean

When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).

isReadOnlyboolean

When true, the element cannot be modified (e.g. published package elements or elements from another workspace).

integrationIdstring

Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.

integrationUuidstring

UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.

integrationKeystring

Key of the integration; alternative to integrationId. Resolved to integrationId by the API.

parentIdstring

Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.

parentUuidstring

UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.

parentKeystring

Key of the parent element; alternative to parentId. Resolved to parentId by the API.

connectionIdstring

Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.

instanceKeystring

Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.

isUniversalboolean

When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.

externalAppIdstring

Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.

externalAppUuidstring

UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.

externalAppKeystring

Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.

Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.

configobject

Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.

{"stackTrail":"components:schemas:ActionApiResponse:properties:outputMapping","oasType":"schema","type":"unknown","description":"Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time."}

isCustomizedboolean

userIdstring

tenantIdstring

universalParentIdstring

For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.

isPublicboolean

When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.

dependenciesobject[]