Refreshes all the dependencies, then resets the element to the default state (from parent)
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
universal, integration, connection Internal database ID of the element. Assigned by the API; unique per element.
Display name. Always present in API responses (filled by API if not set on create).
Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.
Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.
Optional human-readable description.
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.
BUILDING, CLIENT_ACTION_REQUIRED, CONFIGURATION_ERROR, SETUP_FAILED, READY, DISCONNECTING Validation or setup errors when state is not READY.
Opaque revision token; changes on each update. Used for optimistic concurrency.
ISO date when the element was created.
ISO date when the element was last updated.
When set, the element is archived (soft-deleted). Archived elements cannot be patched.
When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).
When true, the element cannot be modified (e.g. published package elements or elements from another workspace).
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.
UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.
Key of the integration; alternative to integrationId. Resolved to integrationId by the API.
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.
UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.
Key of the parent element; alternative to parentId. Resolved to parentId by the API.
Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.
Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.
When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.
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.
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.
Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.
JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.
Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.
list-data-records, find-data-record-by-id, match-data-record, create-data-record, find-or-create-data-record, update-data-record, delete-data-record, search-data-record, connector-operation, api-request-to-external-app, api-request-to-your-app, http-request, run-javascript, api-request Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.
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.
Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.
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.
When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.