Automation

Integrations

Explore the data types and operations available in Integrations.

88 operations

adoptIntegrationIdentityMutation

Register or update an integration's identity without changing record origin or IaC management.

clearIntegrationInstanceSecretMutation

Remove a stored secret from an integration instance. Requires integrationInstance:write permission.

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

createIncomingWebhookMutation

Create a new incoming webhook. Requires incomingWebhook:write permission.

createIntegrationMutation

Declare an integration before any version exists. Requires integration:write permission.

createIntegrationDataContainerMutation

Create a new integration data container. Requires integrationDataContainer:write permission.

createIntegrationDefinitionMutation

Create a new integration definition. Requires integrationDefinition:write permission.

createIntegrationDefinitionSourceMutation

Create a native XML definition in DRAFT status under its integration parent. Creates no installation, bindings or secrets. Requires integrationDefinition:write.

createIntegrationDraftMutation

Create a new integration draft. Requires integrationDefinition:write permission.

createIntegrationInstanceMutation

Create a new integration instance. Requires integrationInstance:write permission.

createIntegrationSessionMutation

Create a session token for an integration instance. Requires integrationInstance:read permission.

createNotificationGroupMutation

Create a new notification group. Requires notificationGroup:write permission.

createNotificationRecipientMutation

Create a new notification recipient. Requires notificationRecipient:write permission.

dataChangeEventsSubscription

Subscribe 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).

deleteIncomingWebhookMutation

Delete an incoming webhook. Requires incomingWebhook:delete permission.

deleteIntegrationMutation

Delete an integration that has no versions. Requires integration:delete permission.

deleteIntegrationDataContainerMutation

Delete an integration data container. Requires integrationDataContainer:delete permission.

deleteIntegrationDefinitionMutation

Delete 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.

deleteIntegrationInstanceMutation

Delete an integration instance. Requires integrationInstance:delete permission.

deleteNotificationGroupMutation

Delete a notification group. Requires notificationGroup:delete permission.

deleteNotificationRecipientMutation

Delete a notification recipient. Requires notificationRecipient:delete permission.

deprecateIntegrationDefinitionMutation

Deprecate an integration definition. Requires integrationDefinition:write permission.

exportIntegrationDefinitionMutation

Export an integration definition to YAML or JSON. Requires integrationDefinition:read permission.

exportIntegrationDefinitionSourceMutation

Export the exact authoritative Integration XML, preserving comments, whitespace and CDATA. Requires integrationDefinition:read.

generateDefaultDataQueryQuery

Generate 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.

getIncomingWebhookQuery

Fetch an incoming webhook by ID. Requires incomingWebhook:read permission.

getIntegrationQuery

Fetch one integration. Requires integration:read permission.

getIntegrationDataContainerQuery

Fetch an integration data container by ID. Requires integrationDataContainer:read permission.

getIntegrationDataContainerByNameQuery

Fetch an integration data container by instance, schema, and name. Requires integrationDataContainer:read permission.

getIntegrationDefinitionQuery

Fetch a single integration definition by ID. Requires integrationDefinition:read permission.

getIntegrationDefinitionObservationQuery

Observe live lifecycle and revision without loading definition content. Requires integrationDefinition:read permission.

getIntegrationInstanceQuery

Fetch a single integration instance by ID. Requires integrationInstance:read permission.

getMagicQueryGraphQLQuery

Resolves 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.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getNotificationGroupQuery

Fetch a notification group by ID. Requires notificationGroup:read permission.

getNotificationRecipientQuery

Fetch a notification recipient by ID. Requires notificationRecipient:read permission.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

Every 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.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

importIntegrationDefinitionMutation

Import an integration definition from YAML or JSON, creating a new DRAFT. Requires integrationDefinition:write permission.

importIntegrationDefinitionSourceMutation

Import exact XML as a new native DRAFT version. Existing versions are never overwritten and installation values are not imported. Requires integrationDefinition:write.

integrationAuthoringCatalogQuery

Compiler-owned XML v1 vocabulary and delegated Workflow/EdgeApp catalogs; definition authoring only.

integrationDefinitionChangesQuery

Complete bounded lifecycle/deletion feed. A reset cursor is captured before full reconciliation; persist only with corresponding observations.

integrationInstanceTimersQuery

List the timers declared in the native v3 definition backing this instance. Requires integrationInstance:read permission.

integrationRuntimeManagementQuery

Read exact runtime identities and management revision before an operator recovery action.

integrationRuntimeRetirementsQuery

Inspect up to 100 retained cleanup sessions, newest first, including operator reconciliation evidence. Works after desired configuration deletion.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.