Automation
Integrations
Explore the data types and operations available in Integrations.
88 operations
Register or update an integration's identity without changing record origin or IaC management.
clearIntegrationInstanceSecretMutationRemove a stored secret from an integration instance. Requires integrationInstance:write permission.
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
createIncomingWebhookMutationCreate a new incoming webhook. Requires incomingWebhook:write permission.
createIntegrationMutationDeclare an integration before any version exists. Requires integration:write permission.
createIntegrationDataContainerMutationCreate a new integration data container. Requires integrationDataContainer:write permission.
createIntegrationDefinitionMutationCreate a new integration definition. Requires integrationDefinition:write permission.
createIntegrationDefinitionSourceMutationCreate a native XML definition in DRAFT status under its integration parent. Creates no installation, bindings or secrets. Requires integrationDefinition:write.
createIntegrationDraftMutationCreate a new integration draft. Requires integrationDefinition:write permission.
createIntegrationInstanceMutationCreate a new integration instance. Requires integrationInstance:write permission.
createIntegrationSessionMutationCreate a session token for an integration instance. Requires integrationInstance:read permission.
createNotificationGroupMutationCreate a new notification group. Requires notificationGroup:write permission.
createNotificationRecipientMutationCreate a new notification recipient. Requires notificationRecipient:write permission.
dataChangeEventsSubscriptionSubscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).
deleteIncomingWebhookMutationDelete an incoming webhook. Requires incomingWebhook:delete permission.
deleteIntegrationMutationDelete an integration that has no versions. Requires integration:delete permission.
deleteIntegrationDataContainerMutationDelete an integration data container. Requires integrationDataContainer:delete permission.
deleteIntegrationDefinitionMutationDelete an integration definition. The final unused version may be deleted, clearing the current version with integration:write permission. Refuses while any instance is installed from it, rather than cascading — an instance reads its definition's manifest at execution time, so removing one underneath a live integration breaks it at the next fire rather than here. Requires integrationDefinition:delete permission.
deleteIntegrationInstanceMutationDelete an integration instance. Requires integrationInstance:delete permission.
deleteNotificationGroupMutationDelete a notification group. Requires notificationGroup:delete permission.
deleteNotificationRecipientMutationDelete a notification recipient. Requires notificationRecipient:delete permission.
deprecateIntegrationDefinitionMutationDeprecate an integration definition. Requires integrationDefinition:write permission.
exportIntegrationDefinitionMutationExport an integration definition to YAML or JSON. Requires integrationDefinition:read permission.
exportIntegrationDefinitionSourceMutationExport the exact authoritative Integration XML, preserving comments, whitespace and CDATA. Requires integrationDefinition:read.
generateDefaultDataQueryQueryGenerate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.
getIncomingWebhookQueryFetch an incoming webhook by ID. Requires incomingWebhook:read permission.
getIntegrationQueryFetch one integration. Requires integration:read permission.
getIntegrationDataContainerQueryFetch an integration data container by ID. Requires integrationDataContainer:read permission.
getIntegrationDataContainerByNameQueryFetch an integration data container by instance, schema, and name. Requires integrationDataContainer:read permission.
getIntegrationDefinitionQueryFetch a single integration definition by ID. Requires integrationDefinition:read permission.
getIntegrationDefinitionObservationQueryObserve live lifecycle and revision without loading definition content. Requires integrationDefinition:read permission.
getIntegrationInstanceQueryFetch a single integration instance by ID. Requires integrationInstance:read permission.
getMagicQueryGraphQLQueryResolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getNotificationGroupQueryFetch a notification group by ID. Requires notificationGroup:read permission.
getNotificationRecipientQueryFetch a notification recipient by ID. Requires notificationRecipient:read permission.
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
iacGuidesQueryEvery authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
importIntegrationDefinitionMutationImport an integration definition from YAML or JSON, creating a new DRAFT. Requires integrationDefinition:write permission.
importIntegrationDefinitionSourceMutationImport exact XML as a new native DRAFT version. Existing versions are never overwritten and installation values are not imported. Requires integrationDefinition:write.
integrationAuthoringCatalogQueryCompiler-owned XML v1 vocabulary and delegated Workflow/EdgeApp catalogs; definition authoring only.
integrationDefinitionChangesQueryComplete bounded lifecycle/deletion feed. A reset cursor is captured before full reconciliation; persist only with corresponding observations.
integrationInstanceTimersQueryList the timers declared in the native v3 definition backing this instance. Requires integrationInstance:read permission.
integrationRuntimeManagementQueryRead exact runtime identities and management revision before an operator recovery action.
integrationRuntimeRetirementsQueryInspect up to 100 retained cleanup sessions, newest first, including operator reconciliation evidence. Works after desired configuration deletion.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.