Integrations
Integration definitions and instances, incoming webhooks and notification routing.
85 operations · complete schema 136 KB
magicQuery
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.
getMagicQuerySchema
Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
listMagicQueries
Lists every available Magic Query noun with a short description and its options — the discovery entry point.
getMagicQueryGraphQL
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.
listDataChangeEventTopics
List all valid data change event topics, grouped by resource. Requires authentication.
generateDefaultDataQuery
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.
ping
Health check endpoint
getIntegration
Fetch one integration. Requires integration:read permission.
listIntegrations
List integrations, one row each. Drill into versions with listIntegrationDefinitions. Requires integration:list permission.
getIntegrationDefinition
Fetch a single integration definition by ID. Requires integrationDefinition:read permission.
listIntegrationDefinitions
List integration definitions with pagination, sorting, and filtering. Requires integrationDefinition:list permission.
integrationAuthoringCatalog
Compiler-owned XML v1 vocabulary and delegated Workflow/EdgeApp catalogs; definition authoring only.
integrationRuntimeRetirements
Inspect up to 100 retained cleanup sessions, newest first, including operator reconciliation evidence. Works after desired configuration deletion.
integrationRuntimeManagement
Read exact runtime identities and management revision before an operator recovery action.
getIntegrationInstance
Fetch a single integration instance by ID. Requires integrationInstance:read permission.
integrationInstanceTimers
List the timers declared in the native v3 definition backing this instance. Requires integrationInstance:read permission.
listIntegrationInstances
List integration instances with pagination, sorting, and filtering. Requires integrationInstance:list permission.
getIntegrationDataContainer
Fetch an integration data container by ID. Requires integrationDataContainer:read permission.
getIntegrationDataContainerByName
Fetch an integration data container by instance, schema, and name. Requires integrationDataContainer:read permission.
listIntegrationDataContainersByInstance
List containers for an integration instance with pagination. Requires integrationDataContainer:list permission.
listIntegrationDataContainersByTaggable
List containers tagged to a specific entity with pagination. Requires integrationDataContainer:list permission.
getNotificationGroup
Fetch a notification group by ID. Requires notificationGroup:read permission.
listNotificationGroups
List notification groups with pagination. Requires notificationGroup:list permission.
getNotificationRecipient
Fetch a notification recipient by ID. Requires notificationRecipient:read permission.
listNotificationRecipients
List notification recipients with pagination. Requires notificationRecipient:list permission.
getIncomingWebhook
Fetch an incoming webhook by ID. Requires incomingWebhook:read permission.
listIncomingWebhooks
List incoming webhooks with pagination and filtering. Requires incomingWebhook:list permission.
iacSchema
The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacValidate
Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
iacGuides
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.
helpChapters
List human-facing manual chapters from the running deployment.
helpChapter
Read a chapter of the current published manual edition.
searchHelp
Search human-facing manuals using shared semantic and text retrieval.
schemaAuthoringCatalog
Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
compileSchemaXML
Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
renderSchemaXML
Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
iacSchemaDocument
Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
verticalProductionUnits
Discover available vertical-specific production units. These values are used with the CUSTOM MetricUnit and the customUnit/customCountUnit/customSpeedUnit fields.
createIntegration
Declare an integration before any version exists. Requires integration:write permission.
publishIntegration
Make a version the integration's current version — the default for new installs. Existing instances are never moved. Requires integration:write permission.
deleteIntegration
Delete an integration that has no versions. Requires integration:delete permission.
createIntegrationDefinition
Create a new integration definition. Requires integrationDefinition:write permission.
deleteIntegrationDefinition
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.
deprecateIntegrationDefinition
Deprecate an integration definition. Requires integrationDefinition:write permission.
createIntegrationDraft
Create a new integration draft. Requires integrationDefinition:write permission.
updateIntegrationDraftFile
Update a single file in a draft's bundle. Requires integrationDefinition:write permission.
updateIntegrationDraftManifest
Update manifest fields on a draft. Requires integrationDefinition:write permission.
validateIntegrationDraft
Validate a draft without publishing. Requires integrationDefinition:write permission.
publishIntegrationDraft
Validate and publish a draft as an active definition. Requires integrationDefinition:write permission.
exportIntegrationDefinition
Export an integration definition to YAML or JSON. Requires integrationDefinition:read permission.
importIntegrationDefinition
Import an integration definition from YAML or JSON, creating a new DRAFT. Requires integrationDefinition:write permission.
validateIntegrationDefinitionSource
Compile XML with the native platform validator without persisting anything. Returns field paths and source ranges. Requires integrationDefinition:read.
createIntegrationDefinitionSource
Create a native XML definition in DRAFT status under its integration parent. Creates no installation, bindings or secrets. Requires integrationDefinition:write.
updateIntegrationDefinitionSource
Replace a native draft XML document using expectedRevision. Root id/version and published versions are immutable. Requires integrationDefinition:write.
importIntegrationDefinitionSource
Import exact XML as a new native DRAFT version. Existing versions are never overwritten and installation values are not imported. Requires integrationDefinition:write.
exportIntegrationDefinitionSource
Export the exact authoritative Integration XML, preserving comments, whitespace and CDATA. Requires integrationDefinition:read.
reconcileRetiredIntegrationRuntime
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.
reconcileIntegrationRuntime
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.
resetIntegrationRuntimeChild
Reset one paused, confirmed-stopped scheduler child's durable attempt budget, with an audited reason and expected management revision. Requires integrationInstance:write.
createIntegrationInstance
Create a new integration instance. Requires integrationInstance:write permission.
setIntegrationInstanceSecret
Set one secret on an integration instance. Secrets are not settable through `config` — this is the only way in. Requires integrationInstance:write permission.
clearIntegrationInstanceSecret
Remove a stored secret from an integration instance. Requires integrationInstance:write permission.
updateIntegrationInstance
Update an integration instance. Requires integrationInstance:write permission.
upgradeIntegrationInstance
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.
startIntegrationInstance
Start an integration instance. Requires integrationInstance:write permission.
pauseIntegrationInstance
Pause an integration instance. Requires integrationInstance:write permission.
runIntegrationAction
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.
runIntegrationTimer
Manually fire a named timer on a running integration instance. Requires integrationInstance:write permission.
deleteIntegrationInstance
Delete an integration instance. Requires integrationInstance:delete permission.
createIntegrationSession
Create a session token for an integration instance. Requires integrationInstance:read permission.
upsertIntegrationDataContainer
Create or update an integration data container. Requires integrationDataContainer:write permission.
createIntegrationDataContainer
Create a new integration data container. Requires integrationDataContainer:write permission.
updateIntegrationDataContainer
Update an integration data container. Only provided fields are changed. Requires integrationDataContainer:write permission.
deleteIntegrationDataContainer
Delete an integration data container. Requires integrationDataContainer:delete permission.
createNotificationGroup
Create a new notification group. Requires notificationGroup:write permission.
updateNotificationGroup
Update a notification group. Requires notificationGroup:write permission.
deleteNotificationGroup
Delete a notification group. Requires notificationGroup:delete permission.
createNotificationRecipient
Create a new notification recipient. Requires notificationRecipient:write permission.
updateNotificationRecipient
Update a notification recipient. Requires notificationRecipient:write permission.
deleteNotificationRecipient
Delete a notification recipient. Requires notificationRecipient:delete permission.
upsertIncomingWebhook
Create or update an incoming webhook. Requires incomingWebhook:write permission.
createIncomingWebhook
Create a new incoming webhook. Requires incomingWebhook:write permission.
updateIncomingWebhook
Update an incoming webhook. Only provided fields are changed. Requires incomingWebhook:write permission.
deleteIncomingWebhook
Delete an incoming webhook. Requires incomingWebhook:delete permission.
dataChangeEvents
Subscribe to real-time data change events. Requires read permission on each requested resource.