# Integrations Integration definitions and instances, incoming webhooks and notification routing. ## Operations ```graphql # Integrations (integrations) # Integration definitions and instances, incoming webhooks and notification routing. # Query compileSchemaXML: String! # Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded generateDefaultDataQuery: String # Generate a default GraphQL data query for an event topic getIncomingWebhook: IncomingWebhookState # Fetch an incoming webhook by ID getIntegration: Integration # Fetch one integration getIntegrationDataContainer: IntegrationDataContainerState # Fetch an integration data container by ID getIntegrationDataContainerByName: IntegrationDataContainerState # Fetch an integration data container by instance, schema, and name getIntegrationDefinition: IntegrationDefinitionState # Fetch a single integration definition by ID getIntegrationInstance: IntegrationInstanceState # Fetch a single integration instance by ID getMagicQueryGraphQL: MagicQueryOperation! # 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 getMagicQuerySchema: MagicQuerySchema! # Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery getNotificationGroup: NotificationGroupState # Fetch a notification group by ID getNotificationRecipient: NotificationRecipientState # Fetch a notification recipient by ID helpChapter: HelpChapter # Read a chapter of the current published manual edition helpChapters: [HelpChapterInfo!]! # List human-facing manual chapters from the running deployment iacGuides: [IaCGuide!]! # Every authoring guide, for a tool that syncs them to a folder iacSchema: IaCSchemaDocument! # The infrastructure-only view of this schema, for declarative tooling iacSchemaDocument: IaCSchemaDocumentPayload! # Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling iacValidate: IaCValidationResult! # Validate an infrastructure artifact integrationAuthoringCatalog: JSON! # Compiler-owned XML v1 vocabulary and delegated Workflow/EdgeApp catalogs; definition authoring only integrationInstanceTimers: [IntegrationInstanceTimer!]! # List the timers declared in the native v3 definition backing this instance integrationRuntimeManagement: IntegrationRuntimeManagementState # Read exact runtime identities and management revision before an operator recovery action integrationRuntimeRetirements: [IntegrationRuntimeRetirementState!]! # Inspect up to 100 retained cleanup sessions, newest first, including operator reconciliation evidence listDataChangeEventTopics: [DataChangeEventGroup!]! # List all valid data change event topics, grouped by resource listIncomingWebhooks: IncomingWebhookConnection! # List incoming webhooks with pagination and filtering listIntegrationDataContainersByInstance: IntegrationDataContainerConnection! # List containers for an integration instance with pagination listIntegrationDataContainersByTaggable: IntegrationDataContainerConnection! # List containers tagged to a specific entity with pagination listIntegrationDefinitions: IntegrationDefinitionConnection! # List integration definitions with pagination, sorting, and filtering listIntegrationInstances: IntegrationInstanceConnection! # List integration instances with pagination, sorting, and filtering listIntegrations: IntegrationConnection! # List integrations, one row each listMagicQueries: [MagicQueryInfo!]! # Lists every available Magic Query noun with a short description and its options — the discovery entry point listNotificationGroups: NotificationGroupConnection! # List notification groups with pagination listNotificationRecipients: NotificationRecipientConnection! # List notification recipients with pagination magicQuery: JSON! # Executes a Magic Query string and returns the predefined query's JSON result ping: String! # Health check endpoint renderSchemaXML: String! # Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document schemaAuthoringCatalog: JSON! # Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations searchHelp: HelpSearchResult! # Search human-facing manuals using shared semantic and text retrieval verticalProductionUnits: [VerticalUnitDescriptor!]! # Discover available vertical-specific production units # Mutation clearIntegrationInstanceSecret: IntegrationInstancePayload! # Remove a stored secret from an integration instance createIncomingWebhook: UpsertIncomingWebhookPayload! # Create a new incoming webhook createIntegration: IntegrationPayload! # Declare an integration before any version exists createIntegrationDataContainer: UpsertIntegrationDataContainerPayload! # Create a new integration data container createIntegrationDefinition: IntegrationDefinitionPayload! # Create a new integration definition createIntegrationDefinitionSource: IntegrationDefinitionPayload! # Create a native XML definition in DRAFT status under its integration parent createIntegrationDraft: IntegrationDefinitionPayload! # Create a new integration draft createIntegrationInstance: IntegrationInstancePayload! # Create a new integration instance createIntegrationSession: IntegrationSessionOutput! # Create a session token for an integration instance createNotificationGroup: UpsertNotificationGroupPayload! # Create a new notification group createNotificationRecipient: UpsertNotificationRecipientPayload! # Create a new notification recipient deleteIncomingWebhook: DeletePayload! # Delete an incoming webhook deleteIntegration: DeletePayload! # Delete an integration that has no versions deleteIntegrationDataContainer: DeletePayload! # Delete an integration data container deleteIntegrationDefinition: DeletePayload! # Delete an integration definition deleteIntegrationInstance: DeletePayload! # Delete an integration instance deleteNotificationGroup: DeletePayload! # Delete a notification group deleteNotificationRecipient: DeletePayload! # Delete a notification recipient deprecateIntegrationDefinition: IntegrationDefinitionPayload! # Deprecate an integration definition exportIntegrationDefinition: ExportIntegrationDefinitionPayload! # Export an integration definition to YAML or JSON exportIntegrationDefinitionSource: IntegrationDefinitionSourceExport! # Export the exact authoritative Integration XML, preserving comments, whitespace and CDATA importIntegrationDefinition: IntegrationDefinitionPayload! # Import an integration definition from YAML or JSON, creating a new DRAFT importIntegrationDefinitionSource: IntegrationDefinitionPayload! # Import exact XML as a new native DRAFT version pauseIntegrationInstance: IntegrationInstancePayload! # Pause an integration instance publishIntegration: IntegrationPayload! # Make a version the integration's current version — the default for new installs publishIntegrationDraft: IntegrationDefinitionPayload! # Validate and publish a draft as an active definition reconcileIntegrationRuntime: IntegrationInstancePayload! # Operator attestation: use ONLY after confirming the exact predecessor process has terminated and reconciling all its external effects reconcileRetiredIntegrationRuntime: IntegrationRuntimeRetirementPayload! # Explicit operator attestation after confirming exact predecessor termination and reconciling all external effects resetIntegrationRuntimeChild: IntegrationInstancePayload! # Reset one paused, confirmed-stopped scheduler child's durable attempt budget, with an audited reason and expected management revision runIntegrationAction: IntegrationActionResult! # Run a named Action a running integration instance declares, and return its handler's JSON result runIntegrationTimer: IntegrationInstancePayload! # Manually fire a named timer on a running integration instance setIntegrationInstanceSecret: IntegrationInstancePayload! # Set one secret on an integration instance startIntegrationInstance: IntegrationInstancePayload! # Start an integration instance updateIncomingWebhook: UpsertIncomingWebhookPayload! # Update an incoming webhook updateIntegrationDataContainer: UpsertIntegrationDataContainerPayload! # Update an integration data container updateIntegrationDefinitionSource: IntegrationDefinitionPayload! # Replace a native draft XML document using expectedRevision updateIntegrationDraftFile: IntegrationDefinitionPayload! # Update a single file in a draft's bundle updateIntegrationDraftManifest: IntegrationDefinitionPayload! # Update manifest fields on a draft updateIntegrationInstance: IntegrationInstancePayload! # Update an integration instance updateNotificationGroup: UpsertNotificationGroupPayload! # Update a notification group updateNotificationRecipient: UpsertNotificationRecipientPayload! # Update a notification recipient upgradeIntegrationInstance: IntegrationInstancePayload! # Move an integration instance to a newer version of the same integration upsertIncomingWebhook: UpsertIncomingWebhookPayload! # Create or update an incoming webhook upsertIntegrationDataContainer: UpsertIntegrationDataContainerPayload! # Create or update an integration data container validateIntegrationDefinitionSource: IntegrationDefinitionSourceValidation! # Compile XML with the native platform validator without persisting anything validateIntegrationDraft: IntegrationValidationResult! # Validate a draft without publishing # Subscription dataChangeEvents: DataChangeEvent! # Subscribe to real-time data change events # Call describe_operation(name) for arguments and input types. ``` ## Exact schema Download [complete SDL](/schemas/integrations.graphql) (138859 bytes). Use the SDL to validate operations; the digest omits argument signatures. ## Guides - [Definitions and instances](/docs/integrations/definitions) - [Configuration, requirements and IAM](/docs/integrations/configuration) - [Integration-owned API clients](/docs/integrations/api-clients) - [Actors and Actions](/docs/integrations/actor-actions) - [Workflows and retained containers](/docs/integrations/workflows-containers) - [Draft, publish and lifecycle APIs](/docs/integrations/lifecycle) - [Diagnostics and XML reference](/docs/integrations/diagnostics-reference) - [Getting started](/docs/integrations/getting-started)