Automation

Integrations

Explore the data types and operations available in Integrations.

88 operations

listIncomingWebhooksQuery

List incoming webhooks with pagination and filtering. Requires incomingWebhook:list permission.

listIntegrationDataContainersByInstanceQuery

List containers for an integration instance with pagination. Requires integrationDataContainer:list permission.

listIntegrationDataContainersByTaggableQuery

List containers tagged to a specific entity with pagination. Requires integrationDataContainer:list permission.

listIntegrationDefinitionsQuery

List integration definitions with pagination, sorting, and filtering. Requires integrationDefinition:list permission.

listIntegrationInstancesQuery

List integration instances with pagination, sorting, and filtering. Requires integrationInstance:list permission.

listIntegrationsQuery

List integrations, one row each. Drill into versions with listIntegrationDefinitions. Requires integration:list permission.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listNotificationGroupsQuery

List notification groups with pagination. Requires notificationGroup:list permission.

listNotificationRecipientsQuery

List notification recipients with pagination. Requires notificationRecipient:list permission.

magicQueryQuery

Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.

pauseIntegrationInstanceMutation

Pause an integration instance. Requires integrationInstance:write permission.

pingQuery

Health check endpoint

publishIntegrationMutation

Make a version the integration's current version — the default for new installs. Existing instances are never moved. Requires integration:write permission.

publishIntegrationDraftMutation

Validate and publish a draft as an active definition. Requires integrationDefinition:write permission.

reconcileIntegrationRuntimeMutation

Operator attestation: use ONLY after confirming the exact predecessor process has terminated and reconciling all its external effects. Records evidence, fences and pauses the installation; preserves attempt budgets. Requires integrationInstance:write.

reconcileRetiredIntegrationRuntimeMutation

Explicit operator attestation after confirming exact predecessor termination and reconciling all external effects. Fences the retired session and retains evidence; never replays or marks a hook successful. Requires integrationInstance:write.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

resetIntegrationRuntimeChildMutation

Reset one paused, confirmed-stopped scheduler child's durable attempt budget, with an audited reason and expected management revision. Requires integrationInstance:write.

runIntegrationActionMutation

Run a named Action a running integration instance declares, and return its handler's JSON result. Discover Actions and their input schemas on the definition's manifest. Requires integrationInstance:write permission.

runIntegrationTimerMutation

Manually fire a named timer on a running integration instance. Requires integrationInstance:write permission.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchHelpQuery

Search human-facing manuals using shared semantic and text retrieval.

setIntegrationInstanceSecretMutation

Set one secret on an integration instance. Secrets are not settable through `config` — this is the only way in. Requires integrationInstance:write permission.

startIntegrationInstanceMutation

Start an integration instance. Requires integrationInstance:write permission.

updateIncomingWebhookMutation

Update an incoming webhook. Only provided fields are changed. Requires incomingWebhook:write permission.

updateIntegrationDataContainerMutation

Update an integration data container. Only provided fields are changed. Requires integrationDataContainer:write permission.

updateIntegrationDefinitionSourceMutation

Replace a native draft XML document using expectedRevision. Root id/version and published versions are immutable. Requires integrationDefinition:write.

updateIntegrationDraftFileMutation

Update a single file in a draft's bundle. Requires integrationDefinition:write permission.

updateIntegrationDraftManifestMutation

Update manifest fields on a draft. Requires integrationDefinition:write permission.

updateIntegrationInstanceMutation

Update an integration instance. Requires integrationInstance:write permission.

updateNotificationGroupMutation

Update a notification group. Requires notificationGroup:write permission.

updateNotificationRecipientMutation

Update a notification recipient. Requires notificationRecipient:write permission.

upgradeIntegrationInstanceMutation

Move an integration instance to a newer version of the same integration. Runs the new definition's upgrade hook between stop and start. Requires integrationInstance:write permission.

upsertIncomingWebhookMutation

Create or update an incoming webhook. Requires incomingWebhook:write permission.

upsertIntegrationDataContainerMutation

Create or update an integration data container. Requires integrationDataContainer:write permission.

validateIntegrationDefinitionSourceMutation

Compile XML with the native platform validator without persisting anything. Returns field paths and source ranges. Requires integrationDefinition:read.

validateIntegrationDraftMutation

Validate a draft without publishing. Requires integrationDefinition:write permission.

verticalProductionUnitsQuery

Discover available vertical-specific production units. These values are used with the CUSTOM MetricUnit and the customUnit/customCountUnit/customSpeedUnit fields.