Automation
Integrations
Explore the data types and operations available in Integrations.
88 operations
List incoming webhooks with pagination and filtering. Requires incomingWebhook:list permission.
listIntegrationDataContainersByInstanceQueryList containers for an integration instance with pagination. Requires integrationDataContainer:list permission.
listIntegrationDataContainersByTaggableQueryList containers tagged to a specific entity with pagination. Requires integrationDataContainer:list permission.
listIntegrationDefinitionsQueryList integration definitions with pagination, sorting, and filtering. Requires integrationDefinition:list permission.
listIntegrationInstancesQueryList integration instances with pagination, sorting, and filtering. Requires integrationInstance:list permission.
listIntegrationsQueryList integrations, one row each. Drill into versions with listIntegrationDefinitions. Requires integration:list permission.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listNotificationGroupsQueryList notification groups with pagination. Requires notificationGroup:list permission.
listNotificationRecipientsQueryList notification recipients with pagination. Requires notificationRecipient:list permission.
magicQueryQueryExecutes 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.
pauseIntegrationInstanceMutationPause an integration instance. Requires integrationInstance:write permission.
pingQueryHealth check endpoint
publishIntegrationMutationMake a version the integration's current version — the default for new installs. Existing instances are never moved. Requires integration:write permission.
publishIntegrationDraftMutationValidate and publish a draft as an active definition. Requires integrationDefinition:write permission.
reconcileIntegrationRuntimeMutationOperator 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.
reconcileRetiredIntegrationRuntimeMutationExplicit 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.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
resetIntegrationRuntimeChildMutationReset one paused, confirmed-stopped scheduler child's durable attempt budget, with an audited reason and expected management revision. Requires integrationInstance:write.
runIntegrationActionMutationRun 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.
runIntegrationTimerMutationManually fire a named timer on a running integration instance. Requires integrationInstance:write permission.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
setIntegrationInstanceSecretMutationSet one secret on an integration instance. Secrets are not settable through `config` — this is the only way in. Requires integrationInstance:write permission.
startIntegrationInstanceMutationStart an integration instance. Requires integrationInstance:write permission.
updateIncomingWebhookMutationUpdate an incoming webhook. Only provided fields are changed. Requires incomingWebhook:write permission.
updateIntegrationDataContainerMutationUpdate an integration data container. Only provided fields are changed. Requires integrationDataContainer:write permission.
updateIntegrationDefinitionSourceMutationReplace a native draft XML document using expectedRevision. Root id/version and published versions are immutable. Requires integrationDefinition:write.
updateIntegrationDraftFileMutationUpdate a single file in a draft's bundle. Requires integrationDefinition:write permission.
updateIntegrationDraftManifestMutationUpdate manifest fields on a draft. Requires integrationDefinition:write permission.
updateIntegrationInstanceMutationUpdate an integration instance. Requires integrationInstance:write permission.
updateNotificationGroupMutationUpdate a notification group. Requires notificationGroup:write permission.
updateNotificationRecipientMutationUpdate a notification recipient. Requires notificationRecipient:write permission.
upgradeIntegrationInstanceMutationMove 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.
upsertIncomingWebhookMutationCreate or update an incoming webhook. Requires incomingWebhook:write permission.
upsertIntegrationDataContainerMutationCreate or update an integration data container. Requires integrationDataContainer:write permission.
validateIntegrationDefinitionSourceMutationCompile XML with the native platform validator without persisting anything. Returns field paths and source ranges. Requires integrationDefinition:read.
validateIntegrationDraftMutationValidate a draft without publishing. Requires integrationDefinition:write permission.
verticalProductionUnitsQueryDiscover available vertical-specific production units. These values are used with the CUSTOM MetricUnit and the customUnit/customCountUnit/customSpeedUnit fields.