{ "openapi": "3.0.0", "paths": { "/act": { "post": { "operationId": "act", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActResponseDto" } } } } }, "summary": "Run an action", "tags": ["Act"] } }, "/action-run-logs": { "get": { "operationId": "listActionRunLogs", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "actionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "universalActionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationActionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionActionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string", "enum": ["success", "error"] } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto" } } } } }, "summary": "List action run logs", "tags": ["ActionRunLogs"] } }, "/action-run-logs/{id}": { "get": { "operationId": "getActionRunLog", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto" } } } } }, "summary": "Get action run log", "tags": ["ActionRunLogs"] } }, "/action-run-logs/{id}/details": { "get": { "operationId": "getActionRunLogDetails", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRunLogRecordInDb" } } } } }, "summary": "Get action run log details", "tags": ["ActionRunLogs"] } }, "/actions": { "get": { "operationId": "listActions", "parameters": [ { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "parentId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "universalParentId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isUniversal", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "intent", "required": false, "in": "query", "schema": { "maxLength": 200, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto" } } } } }, "summary": "List actions", "tags": ["Actions"] }, "post": { "description": "Creates an integration-level action (workspace-wide) or a connection-level action instance when `connectionId` is provided. Supports intent-based creation: include an `intent` field to launch an action-building agent.", "operationId": "createAction", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAction" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionApiResponse" } } } } }, "summary": "Create a new action", "tags": ["Actions"] } }, "/actions/{selector}": { "get": { "operationId": "getAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionApiResponseDto" } } } } }, "summary": "Get action by selector", "tags": ["Actions"] }, "patch": { "operationId": "patchAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAction" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionApiResponse" } } } } }, "summary": "Update action partially", "tags": ["Actions"] }, "put": { "operationId": "replaceAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAction" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionApiResponse" } } } } }, "summary": "Replace action completely", "tags": ["Actions"] }, "delete": { "operationId": "archiveAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive action", "tags": ["Actions"] } }, "/actions/{selector}/clone": { "post": { "operationId": "cloneAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionApiResponse" } } } } }, "summary": "Clone action", "tags": ["Actions"] } }, "/actions/{selector}/dependencies": { "get": { "operationId": "getActionDependencies", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of action (flat interface)", "tags": ["Actions"] } }, "/actions/{selector}/export": { "get": { "operationId": "exportAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionExportProperties" } } } } }, "summary": "Export action (flat interface)", "tags": ["Actions"] } }, "/actions/{selector}/refresh": { "post": { "operationId": "refreshAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionApiResponse" } } } } }, "summary": "Refresh action", "tags": ["Actions"] } }, "/actions/{selector}/reset": { "post": { "description": "Refreshes all the dependencies, then resets the element to the default state (from parent)", "operationId": "resetAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionApiResponse" } } } } }, "summary": "Reset action", "tags": ["Actions"] } }, "/actions/{selector}/restore": { "post": { "operationId": "restoreAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionApiResponse" } } } } }, "summary": "Restore action (flat interface)", "tags": ["Actions"] } }, "/actions/{selector}/run": { "post": { "deprecated": true, "description": "Deprecated: Use POST /act with { action: { id } } or { integrationKey, key } in the body instead.", "operationId": "runAction", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRunRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRunResponseDto" } } } } }, "summary": "Run an action", "tags": ["Actions"] } }, "/agent/sessions": { "get": { "operationId": "listAgentSessions", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "workspaceElementType", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] } }, { "name": "workspaceElementId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "agentHarnessId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "startDatetime", "required": false, "in": "query", "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, { "name": "endDatetime", "required": false, "in": "query", "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string", "enum": ["queued", "starting", "running", "completed", "failed", "cancelled"] } }, { "name": "isExternal", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSessionsPaginatedResponseDto" } } } } }, "summary": "List agent sessions", "tags": ["Sessions"] }, "post": { "operationId": "createAgentSession", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentSessionDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSessionDto" } } } } }, "summary": "Create a new agent session", "tags": ["Sessions"] } }, "/agent/sessions/{id}": { "get": { "operationId": "getAgentSession", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "wait", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "timeout", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 60, "default": 30, "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSessionDto" } } } } }, "summary": "Get an agent session", "tags": ["Sessions"] }, "patch": { "operationId": "patchAgentSession", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAgentSessionDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSessionDto" } } } } }, "summary": "Update an agent session", "tags": ["Sessions"] } }, "/agent/sessions/{id}/interrupt": { "post": { "operationId": "interruptAgentSession", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSessionInterruptResponseDto" } } } } }, "summary": "Interrupt a running agent session", "tags": ["Sessions"] } }, "/agent/sessions/{id}/message": { "post": { "operationId": "sendAgentSessionMessage", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSessionInputDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSessionDto" } } } } }, "summary": "Send a message to a session (resumes if stopped, sends input if running)", "tags": ["Sessions"] } }, "/agent/sessions/{id}/stop": { "patch": { "operationId": "stopAgentSession", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSessionDto" } } } } }, "summary": "Stop an agent session", "tags": ["Sessions"] } }, "/agent/tools/search-apps": { "post": { "operationId": "searchApps", "parameters": [ { "name": "x-membrane-session-id", "in": "header", "description": "Agent Session ID", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSearchRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchAppsResponseDto" } } } } }, "summary": "Find apps, SaaS tools, services or APIs that match a query, using web search.", "tags": ["Tools"] } }, "/agent/tools/websearch": { "post": { "operationId": "websearch", "parameters": [ { "name": "x-membrane-session-id", "in": "header", "description": "Agent Session ID", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSearchRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } }, "summary": "Run a search query to search the internet for results. Use this to look up latest information or find documentation.", "tags": ["Tools"] } }, "/app-data-schemas": { "get": { "operationId": "listAppDataSchemas", "parameters": [ { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "isUniversal", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "appDataSchemaId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemasPaginatedResponseDto" } } } } }, "summary": "List app data schemas", "tags": ["AppDataSchemas"] }, "post": { "operationId": "createAppDataSchema", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemaCreateDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemaDto" } } } } }, "summary": "Create app data schema", "tags": ["AppDataSchemas"] } }, "/app-data-schemas/{elementSelector}/dependencies": { "get": { "operationId": "getAppDataSchemaDependencies", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of a app data schema", "tags": ["AppDataSchemas"] } }, "/app-data-schemas/{elementSelector}/restore": { "post": { "operationId": "restoreAppDataSchema", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Restore (unarchive) app data schema", "tags": ["AppDataSchemas"] } }, "/app-data-schemas/{idOrKey}": { "get": { "operationId": "getAppDataSchema", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "description": "App data schema ID or key", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "isUniversal", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "appDataSchemaId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemaDto" } } } } }, "summary": "Get app data schema by selector", "tags": ["AppDataSchemas"] }, "put": { "operationId": "updateAppDataSchema", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "description": "App data schema ID or key", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemaCreateDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemaDto" } } } } }, "summary": "Update app data schema by selector", "tags": ["AppDataSchemas"] }, "patch": { "operationId": "patchAppDataSchema", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "description": "App data schema ID or key", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemaUpdateDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemaDto" } } } } }, "summary": "Patch app data schema by selector", "tags": ["AppDataSchemas"] }, "delete": { "operationId": "archiveAppDataSchema", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "description": "App data schema ID or key", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive app data schema by selector", "tags": ["AppDataSchemas"] } }, "/app-data-schemas/{idOrKey}/export": { "get": { "operationId": "exportAppDataSchema", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "description": "App data schema ID or key", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemaExportDto" } } } } }, "summary": "Export app data schema by selector", "tags": ["AppDataSchemas"] } }, "/app-data-schemas/{idOrKey}/refresh": { "post": { "operationId": "refreshAppDataSchema", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "description": "App data schema ID or key", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDataSchemaDto" } } } } }, "summary": "Refresh app data schema by selector", "tags": ["AppDataSchemas"] } }, "/app-event-subscriptions": { "get": { "operationId": "listAppEventSubscriptions", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "id", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "appEventTypeId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isSubscribed", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto" } } } } }, "summary": "List internal event subscriptions", "tags": ["AppEventSubscriptions"] } }, "/app-event-subscriptions/{elementSelector}/dependencies": { "get": { "operationId": "getAppEventSubscriptionDependencies", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of a app event subscription", "tags": ["AppEventSubscriptions"] } }, "/app-event-subscriptions/{elementSelector}/refresh": { "post": { "operationId": "refreshAppEventSubscription", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Refresh app event subscription", "tags": ["AppEventSubscriptions"] } }, "/app-event-subscriptions/{elementSelector}/restore": { "post": { "operationId": "restoreAppEventSubscription", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Restore (unarchive) app event subscription", "tags": ["AppEventSubscriptions"] } }, "/app-event-subscriptions/{id}": { "get": { "operationId": "getAppEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto" } } } } }, "summary": "Get internal event subscription by id", "tags": ["AppEventSubscriptions"] }, "patch": { "operationId": "patchAppEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventSubscriptionUpdateDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto" } } } } }, "summary": "Update internal event subscription by id", "tags": ["AppEventSubscriptions"] }, "put": { "operationId": "updateAppEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventSubscriptionUpdateDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto" } } } } }, "summary": "Update internal event subscription by id", "tags": ["AppEventSubscriptions"] }, "delete": { "operationId": "archiveAppEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive internal event subscription by id", "tags": ["AppEventSubscriptions"] } }, "/app-event-subscriptions/{id}/schema": { "get": { "operationId": "getAppEventSubscriptionSchema", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventSubscriptionSchemaResponseDto" } } } } }, "summary": "Get internal event subscription schema by id", "tags": ["AppEventSubscriptions"] } }, "/app-event-subscriptions/{id}/subscribe": { "post": { "operationId": "subscribeToAppEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto" } } } } }, "summary": "Subscribe to internal event subscription by id", "tags": ["AppEventSubscriptions"] } }, "/app-event-types": { "get": { "operationId": "listAppEventTypes", "parameters": [ { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventTypesPaginatedResponseDto" } } } } }, "summary": "List internal event types", "tags": ["AppEventTypes"] }, "post": { "operationId": "createAppEventType", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppEventTypeDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto" } } } } }, "summary": "Create internal event type", "tags": ["AppEventTypes"] } }, "/app-event-types/{elementSelector}/dependencies": { "get": { "operationId": "getAppEventTypeDependencies", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of a app event type", "tags": ["AppEventTypes"] } }, "/app-event-types/{elementSelector}/refresh": { "post": { "operationId": "refreshAppEventType", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Refresh app event type", "tags": ["AppEventTypes"] } }, "/app-event-types/{elementSelector}/restore": { "post": { "operationId": "restoreAppEventType", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Restore (unarchive) app event type", "tags": ["AppEventTypes"] } }, "/app-event-types/{id}": { "get": { "operationId": "getAppEventType", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto" } } } } }, "summary": "Get internal event type", "tags": ["AppEventTypes"] }, "put": { "operationId": "updateAppEventType", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppEventTypeDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto" } } } } }, "summary": "Update internal event type", "tags": ["AppEventTypes"] }, "patch": { "operationId": "patchAppEventType", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppEventTypeDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto" } } } } }, "summary": "Patch internal event type", "tags": ["AppEventTypes"] }, "delete": { "operationId": "deleteAppEventType", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive internal event type", "tags": ["AppEventTypes"] } }, "/app-event-types/{id}/export": { "get": { "operationId": "exportAppEventType", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventTypeExportDto" } } } } }, "summary": "Export Internal Event Type to JSON", "tags": ["AppEventTypes"] } }, "/app-event-types/{id}/schema": { "get": { "operationId": "getAppEventTypeSchema", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventSubscriptionSchemaResponseDto" } } } } }, "summary": "Get internal event type schema", "tags": ["AppEventTypes"] } }, "/app-events": { "get": { "operationId": "listAppEventLogRecords", "parameters": [ { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "appEventTypeId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto" } } } } }, "summary": "List internal event log records", "tags": ["AppEventLogRecords"] } }, "/app-events/{id}": { "get": { "operationId": "getAppEventLogRecord", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto" } } } } }, "summary": "Get internal event log record", "tags": ["AppEventLogRecords"] } }, "/checkpoints": { "get": { "operationId": "getCheckpoints", "parameters": [ { "name": "elementType", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "elementId", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CheckpointApiResponseDto" } } } } } }, "summary": "List checkpoints for a workspace element", "tags": ["Checkpoints"] } }, "/checkpoints/{id}": { "get": { "operationId": "getCheckpoint", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckpointApiResponseDto" } } } } }, "summary": "Get a checkpoint by ID", "tags": ["Checkpoints"] } }, "/checkpoints/{id}/diff": { "get": { "operationId": "getCheckpointDiff", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckpointDiffResponseDto" } } } } }, "summary": "Get diff between current element state and checkpoint", "tags": ["Checkpoints"] } }, "/checkpoints/{id}/revert": { "post": { "operationId": "revertToCheckpoint", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Revert workspace element to checkpoint state", "tags": ["Checkpoints"] } }, "/connected-products": { "get": { "operationId": "listConnectedProducts", "parameters": [ { "name": "type", "required": false, "in": "query", "schema": { "type": "string", "enum": ["ai-agent", "app"] } }, { "name": "audience", "required": false, "in": "query", "schema": { "type": "string", "enum": ["personal", "customers"] } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedProductsPaginatedResponseDto" } } } } }, "summary": "List all connected products", "tags": ["ConnectedProducts"] }, "post": { "operationId": "createConnectedProduct", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectedProductRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedProductApiResponseDto" } } } } }, "summary": "Create a new connected product", "tags": ["ConnectedProducts"] } }, "/connected-products/{elementSelector}/restore": { "post": { "operationId": "restoreConnectedProduct", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Restore (unarchive) connected product", "tags": ["ConnectedProducts"] } }, "/connected-products/{id}": { "get": { "operationId": "getConnectedProduct", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedProductApiResponseDto" } } } } }, "summary": "Get connected product by ID", "tags": ["ConnectedProducts"] }, "put": { "operationId": "updateConnectedProduct", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectedProductRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedProductApiResponseDto" } } } } }, "summary": "Update connected product completely", "tags": ["ConnectedProducts"] }, "patch": { "operationId": "patchConnectedProduct", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectedProductRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedProductApiResponseDto" } } } } }, "summary": "Update connected product partially", "tags": ["ConnectedProducts"] }, "delete": { "operationId": "deleteConnectedProduct", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Delete a connected product", "tags": ["ConnectedProducts"] } }, "/connections": { "get": { "operationId": "listConnections", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "description": "Filter by integration ID", "schema": { "type": "string" } }, { "name": "connectorId", "required": false, "in": "query", "description": "Filter by connector ID", "schema": { "type": "string" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connected", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "disconnected", "required": false, "in": "query", "description": "[DEPRECATED] Use `connected` instead.", "schema": { "type": "boolean" } }, { "name": "isTest", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectorVersion", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "includeSecrets", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsPaginatedResponseDto" } } } } }, "summary": "List all connections", "tags": ["Connections"] }, "post": { "operationId": "createConnection", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectionDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionApiResponseDto" } } } } }, "summary": "Create a new connection", "tags": ["Connections"] } }, "/connections/ensure": { "post": { "operationId": "ensureConnection", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnsureConnectionDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionApiResponseDto" } } } } }, "summary": "Find or create a connection", "tags": ["Connections"] } }, "/connections/{elementSelector}/dependencies": { "get": { "operationId": "getConnectionDependencies", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of a connection", "tags": ["Connections"] } }, "/connections/{elementSelector}/logs": { "get": { "operationId": "getConnectionLogs", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementLogsResponseDto" } } } } }, "summary": "Get connection logs", "tags": ["Connections"] } }, "/connections/{elementSelector}/refresh": { "post": { "operationId": "refreshConnection", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Refresh connection", "tags": ["Connections"] } }, "/connections/{elementSelector}/restore": { "post": { "operationId": "restoreConnection", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Restore (unarchive) connection", "tags": ["Connections"] } }, "/connections/{id}": { "get": { "operationId": "getConnection", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "includeSecrets", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "wait", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "timeout", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 60, "default": 30, "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionApiResponseDto" } } } } }, "summary": "Get connection by ID", "tags": ["Connections"] }, "put": { "operationId": "updateConnection", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionApiResponseDto" } } } } }, "summary": "Update connection completely", "tags": ["Connections"] }, "patch": { "operationId": "patchConnection", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionApiResponseDto" } } } } }, "summary": "Update connection partially", "tags": ["Connections"] }, "delete": { "operationId": "archiveConnection", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive a connection", "tags": ["Connections"] } }, "/connections/{id}/data": { "get": { "operationId": "listConnectionDataCollections", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "List connection data collections", "tags": ["DataCollections"] } }, "/connections/{id}/data/{dataCollectionKey}": { "get": { "operationId": "getConnectionDataCollection", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataCollectionKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionSpecDto" } } } } }, "summary": "Get data collection specification", "tags": ["DataCollections"] } }, "/connections/{id}/data/{dataCollectionKey}/create": { "post": { "operationId": "createDataCollectionRecord", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataCollectionKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionCreateRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionCreateResponseDto" } } } } }, "summary": "Create record in data collection", "tags": ["DataCollections"] } }, "/connections/{id}/data/{dataCollectionKey}/delete": { "post": { "operationId": "deleteDataCollectionRecord", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataCollectionKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionDeleteRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionDeleteResponseDto" } } } } }, "summary": "Delete record in data collection", "tags": ["DataCollections"] } }, "/connections/{id}/data/{dataCollectionKey}/find-by-id": { "post": { "operationId": "findDataCollectionRecordById", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataCollectionKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionFindByIdRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionFindByIdResponseDto" } } } } }, "summary": "Find record by ID in data collection", "tags": ["DataCollections"] } }, "/connections/{id}/data/{dataCollectionKey}/list": { "post": { "operationId": "listDataCollectionRecords", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataCollectionKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionListRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionListResponseDto" } } } } }, "summary": "List records in data collection", "tags": ["DataCollections"] } }, "/connections/{id}/data/{dataCollectionKey}/match": { "post": { "operationId": "matchDataCollectionRecord", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataCollectionKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionMatchRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionMatchResponseDto" } } } } }, "summary": "Find a matching record in a data collection", "tags": ["DataCollections"] } }, "/connections/{id}/data/{dataCollectionKey}/refresh": { "post": { "operationId": "refreshConnectionDataCollection", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataCollectionKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionSpecDto" } } } } }, "summary": "Refresh data collection specification", "tags": ["DataCollections"] } }, "/connections/{id}/data/{dataCollectionKey}/search": { "post": { "operationId": "searchDataCollectionRecords", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataCollectionKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionSearchRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionSearchResponseDto" } } } } }, "summary": "Search records in a data collection", "tags": ["DataCollections"] } }, "/connections/{id}/data/{dataCollectionKey}/update": { "post": { "operationId": "updateDataCollectionRecord", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataCollectionKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionUpdateRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionUpdateResponseDto" } } } } }, "summary": "Update record in data collection", "tags": ["DataCollections"] } }, "/connections/{id}/disconnect": { "post": { "operationId": "disconnectConnection", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "204": { "description": "" } }, "summary": "Disconnect a connection, revoking and erasing its credentials", "tags": ["Connections"] } }, "/connections/{id}/export": { "get": { "operationId": "exportConnection", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "includeSecrets", "required": true, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionExportDto" } } } } }, "summary": "Export connection configuration", "tags": ["Connections"] } }, "/connections/{id}/refresh-credentials": { "post": { "operationId": "refreshConnectionCredentials", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "204": { "description": "" } }, "summary": "Refresh connection credentials", "tags": ["Connections"] } }, "/connections/{id}/test": { "post": { "operationId": "testConnection", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponseDto" } } } } }, "summary": "Test connection validity", "tags": ["Connections"] } }, "/connectors": { "get": { "operationId": "listConnectors", "parameters": [ { "name": "limit", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "workspaceId", "required": false, "in": "query", "description": "[INTERNAL] Legacy field for backward compatibility", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "appUuid", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorsPaginatedResponseDto" } } } } }, "summary": "List all connectors", "tags": ["Connectors"] }, "post": { "operationId": "createConnector", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectorDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } } }, "summary": "Create a new connector", "tags": ["Connectors"] } }, "/connectors/{idOrKey}": { "get": { "operationId": "getConnector", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "version", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } } }, "summary": "Get connector", "tags": ["Connectors"] }, "patch": { "operationId": "patchConnector", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectorDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } } }, "summary": "Update connector partially", "tags": ["Connectors"] }, "put": { "operationId": "putConnector", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectorDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } } }, "summary": "Update connector completely", "tags": ["Connectors"] }, "delete": { "operationId": "deleteConnector", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Delete a connector", "tags": ["Connectors"] } }, "/connectors/{idOrKey}/clone": { "post": { "operationId": "cloneConnector", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneConnectorDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } } }, "summary": "Clone connector to workspace", "tags": ["Connectors"] } }, "/connectors/{idOrKey}/directories/{path}": { "delete": { "operationId": "deleteConnectorDirectory", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "path", "required": true, "in": "path", "description": "Path to the directory", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Delete connector directory", "tags": ["Connectors"] } }, "/connectors/{idOrKey}/download": { "get": { "operationId": "downloadConnector", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "version", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Connector zip file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDownloadResponseDto" } } } } }, "summary": "Download connector as zip file", "tags": ["Connectors"] } }, "/connectors/{idOrKey}/export-files": { "get": { "operationId": "exportConnectorFiles", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "version", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The job id and access key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestTriggerResponseDto" } } } } }, "summary": "Export connector as zip file", "tags": ["Connectors"] } }, "/connectors/{idOrKey}/export-json": { "get": { "operationId": "exportConnectorJson", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "version", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorExportPropertiesDto" } } } } }, "summary": "Export connector as JSON", "tags": ["Connectors"] } }, "/connectors/{idOrKey}/files": { "get": { "operationId": "listConnectorFiles", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "directory", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "recursive", "required": true, "in": "query", "schema": { "type": "boolean" } }, { "name": "version", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "summary": "Get a list of connector files", "tags": ["Connectors"] } }, "/connectors/{idOrKey}/files/{path}": { "get": { "operationId": "getConnectorFile", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "path", "required": true, "in": "path", "description": "Path to the file", "schema": { "type": "string" } }, { "name": "version", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } }, "summary": "Get connector file by path", "tags": ["Connectors"] }, "put": { "operationId": "putConnectorFile", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "path", "required": true, "in": "path", "description": "Path to the file", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "File contents", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "File updated successfully, returns corrected path", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutConnectorFileResponseDto" } } } } }, "summary": "Update connector file", "tags": ["Connectors"] }, "delete": { "operationId": "deleteConnectorFile", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "path", "required": true, "in": "path", "description": "Path to the file", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Delete connector file", "tags": ["Connectors"] } }, "/connectors/{idOrKey}/import": { "post": { "operationId": "importConnector", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportConnectorDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } } }, "summary": "Import connector from external source", "tags": ["Connectors"] } }, "/connectors/{idOrKey}/upload": { "post": { "operationId": "uploadConnector", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } } }, "summary": "Upload connector from zip file", "tags": ["Connectors"] } }, "/connectors/{key}/publish-version": { "post": { "operationId": "publishConnectorVersion", "parameters": [ { "name": "key", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionDto" } } } } }, "summary": "Publish a new version of connector", "tags": ["Connectors"] } }, "/connectors/{key}/versions": { "get": { "operationId": "getConnectorVersions", "parameters": [ { "name": "key", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorVersionDto" } } } } } }, "summary": "Get all versions of a connector", "tags": ["Connectors"] } }, "/connectors/{key}/versions/{versionId}": { "delete": { "operationId": "deleteConnectorVersion", "parameters": [ { "name": "key", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "versionId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Delete a specific version of a connector", "tags": ["Connectors"] } }, "/customers": { "get": { "operationId": "listCustomers", "parameters": [ { "name": "isTest", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "isActive", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersPaginatedResponseDto" } } } } }, "summary": "List all customers", "tags": ["Customers"] }, "post": { "operationId": "createCustomer", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiResponseDto" } } } } }, "summary": "Create a new customer", "tags": ["Customers"] } }, "/customers/{elementSelector}/restore": { "post": { "operationId": "restoreCustomer", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Restore (unarchive) customer", "tags": ["Customers"] } }, "/customers/{id}": { "get": { "operationId": "getCustomer", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiResponseDto" } } } } }, "summary": "Get customer by ID", "tags": ["Customers"] }, "put": { "operationId": "updateCustomer", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerAsAdminDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiResponseDto" } } } } }, "summary": "Update customer completely", "tags": ["Customers"] }, "patch": { "operationId": "patchCustomer", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerAsAdminDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiResponseDto" } } } } }, "summary": "Update customer partially", "tags": ["Customers"] }, "delete": { "operationId": "deleteCustomer", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Delete a customer", "tags": ["Customers"] } }, "/data-link-tables": { "get": { "operationId": "listDataLinkTables", "parameters": [ { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "connection"] } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "dataLinkTableId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataLinkTablesPaginatedResponseDto" } } } } }, "summary": "List data link tables", "tags": ["DataLinkTables"] }, "post": { "operationId": "createDataLinkTable", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataLinkTableDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataLinkTableApiResponseDto" } } } } }, "summary": "Create data link table", "tags": ["DataLinkTables"] } }, "/data-link-tables/{elementSelector}/dependencies": { "get": { "operationId": "getDataLinkTableDependencies", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of a data link table", "tags": ["DataLinkTables"] } }, "/data-link-tables/{elementSelector}/refresh": { "post": { "operationId": "refreshDataLinkTable", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Refresh data link table", "tags": ["DataLinkTables"] } }, "/data-link-tables/{elementSelector}/restore": { "post": { "operationId": "restoreDataLinkTable", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Restore (unarchive) data link table", "tags": ["DataLinkTables"] } }, "/data-link-tables/{idOrKey}": { "get": { "operationId": "getDataLinkTable", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "connection"] } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "dataLinkTableId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataLinkTableApiResponseDto" } } } } }, "summary": "Get data link table", "tags": ["DataLinkTables"] }, "put": { "operationId": "updateDataLinkTable", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataLinkTableDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataLinkTableApiResponseDto" } } } } }, "summary": "Update data link table", "tags": ["DataLinkTables"] }, "patch": { "operationId": "patchDataLinkTable", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataLinkTableDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataLinkTableApiResponseDto" } } } } }, "summary": "Patch data link table", "tags": ["DataLinkTables"] }, "delete": { "operationId": "deleteDataLinkTable", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive data link table", "tags": ["DataLinkTables"] } }, "/data-link-tables/{idOrKey}/export": { "get": { "operationId": "exportDataLinkTable", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataLinkTableExportDto" } } } } }, "summary": "Export data link table", "tags": ["DataLinkTables"] } }, "/data-link-tables/{idOrKey}/links": { "get": { "operationId": "getDataLinkTableLinks", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "dataLinkTableId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "dataLinkTableKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "autoCreate", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "direction", "required": false, "in": "query", "schema": { "type": "string", "enum": ["import", "export", "both"] } }, { "name": "appRecordId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalRecordId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataLinksPaginatedResponseDto" } } } } }, "summary": "Get data links for a data link table instance", "tags": ["DataLinkTables"] }, "post": { "operationId": "createDataLinkTableLink", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "dataLinkTableId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "dataLinkTableKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "autoCreate", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "direction", "required": false, "in": "query", "schema": { "type": "string", "enum": ["import", "export", "both"] } }, { "name": "appRecordId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalRecordId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataLinkDto" } } } }, "responses": { "204": { "description": "Data link created successfully" } }, "summary": "Create a data link", "tags": ["DataLinkTables"] }, "delete": { "operationId": "deleteDataLinkTableLink", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "dataLinkTableId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "dataLinkTableKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "autoCreate", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "direction", "required": false, "in": "query", "schema": { "type": "string", "enum": ["import", "export", "both"] } }, { "name": "appRecordId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalRecordId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDataLinkDto" } } } }, "responses": { "200": { "description": "" } }, "summary": "Delete a data link", "tags": ["DataLinkTables"] } }, "/data-links": { "get": { "operationId": "listDataLinks", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "dataLinkTableInstanceId", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "externalRecordId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "appRecordId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "direction", "required": false, "in": "query", "schema": { "type": "string", "enum": ["import", "export", "both"] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataLinksPaginatedResponseDto" } } } } }, "summary": "List data links", "tags": ["DataLinks"] } }, "/data-links/{dataLinkId}": { "delete": { "operationId": "deleteDataLink", "parameters": [ { "name": "dataLinkId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Delete data link", "tags": ["DataLinks"] } }, "/data-sources": { "get": { "operationId": "listDataSources", "parameters": [ { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "universalParentId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isUniversal", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "dataSourceId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "universalDataSourceId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourcePaginatedResponse" } } } } }, "summary": "List data sources", "tags": ["DataSources"] }, "post": { "operationId": "createDataSource", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataSource" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceApiResponse" } } } } }, "summary": "Create a new data source", "tags": ["DataSources"] } }, "/data-sources/{selector}": { "get": { "operationId": "getDataSource", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceApiResponse" } } } } }, "summary": "Get data source by selector", "tags": ["DataSources"] }, "patch": { "operationId": "patchDataSource", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSource" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceApiResponse" } } } } }, "summary": "Update data source partially", "tags": ["DataSources"] }, "put": { "operationId": "replaceDataSource", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataSource" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceApiResponse" } } } } }, "summary": "Replace data source completely", "tags": ["DataSources"] }, "delete": { "operationId": "archiveDataSource", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive data source", "tags": ["DataSources"] } }, "/data-sources/{selector}/clone": { "post": { "operationId": "cloneDataSource", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceApiResponse" } } } } }, "summary": "Clone data source", "tags": ["DataSources"] } }, "/data-sources/{selector}/dependencies": { "get": { "operationId": "getDataSourceDependencies", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of data source (flat interface)", "tags": ["DataSources"] } }, "/data-sources/{selector}/export": { "get": { "operationId": "exportDataSource", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceExportProperties" } } } } }, "summary": "Export data source (flat interface)", "tags": ["DataSources"] } }, "/data-sources/{selector}/refresh": { "post": { "operationId": "refreshDataSource", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceApiResponse" } } } } }, "summary": "Refresh data source", "tags": ["DataSources"] } }, "/data-sources/{selector}/reset": { "post": { "description": "Refreshes all the dependencies, then resets the element to the default state (from parent)", "operationId": "resetDataSource", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceApiResponse" } } } } }, "summary": "Reset data source", "tags": ["DataSources"] } }, "/data-sources/{selector}/restore": { "post": { "operationId": "restoreDataSource", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceApiResponse" } } } } }, "summary": "Restore data source (flat interface)", "tags": ["DataSources"] } }, "/export": { "get": { "operationId": "exportWorkspace", "parameters": [ { "name": "simplified", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "The job id and access key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestTriggerResponseDto" } } } } }, "summary": "Export all workspace elements", "tags": ["ExportMembraneInterfaces"] } }, "/external-api-logs": { "get": { "operationId": "listExternalApiLogs", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isSuccess", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "sortOrder", "required": false, "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExternalApiLogsResponseDto" } } } } }, "summary": "List external API logs", "tags": ["ExternalApiLogs"] } }, "/external-api-logs/{id}": { "get": { "operationId": "getExternalApiLog", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogsDto" } } } } }, "summary": "Get API log by ID", "tags": ["ExternalApiLogs"] } }, "/external-api-logs/{id}/details": { "get": { "operationId": "getExternalApiLogContent", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLogDetailsDto" } } } } }, "summary": "Get API log content", "tags": ["ExternalApiLogs"] } }, "/external-apps": { "get": { "description": "Returns workspace apps first, then public apps.", "operationId": "listApps", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "category", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isConnected", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppsPaginatedResponseDto" } } } } }, "summary": "List apps", "tags": ["ExternalApps"] }, "post": { "operationId": "createApp", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExternalAppDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppDto" } } } } }, "summary": "Create a new app", "tags": ["ExternalApps"] } }, "/external-apps/{idOrKeyOrUuid}": { "get": { "description": "Returns a public app by its ID, key, or UUID with OpenAPI specs.", "operationId": "getApp", "parameters": [ { "name": "idOrKeyOrUuid", "required": true, "in": "path", "description": "App ID, key, or UUID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppDto" } } } } }, "summary": "Get a single app", "tags": ["ExternalApps"] }, "patch": { "operationId": "updateApp", "parameters": [ { "name": "idOrKeyOrUuid", "required": true, "in": "path", "description": "App ID, key, or UUID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExternalAppDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppDto" } } } } }, "summary": "Update an app", "tags": ["ExternalApps"] }, "delete": { "operationId": "deleteApp", "parameters": [ { "name": "idOrKeyOrUuid", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Delete an app", "tags": ["ExternalApps"] } }, "/external-event-log-records": { "get": { "operationId": "listExternalEventLogRecords", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalEventSubscriptionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalEventTypeId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string", "enum": ["created", "error", "success"] } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventLogRecordsPaginatedResponseDto" } } } } }, "summary": "List external event log records", "tags": ["ExternalEventLogRecords"] } }, "/external-event-log-records/{id}": { "get": { "operationId": "getExternalEventLogRecord", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventLogRecordApiResponseDto" } } } } }, "summary": "Get external event log record", "tags": ["ExternalEventLogRecords"] } }, "/external-event-log-records/{id}/details": { "get": { "operationId": "getExternalEventLogRecordDetails", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventLogRecordInDb" } } } } }, "summary": "Get external event log record details", "tags": ["ExternalEventLogRecords"] } }, "/external-event-pulls": { "get": { "operationId": "listExternalEventPulls", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "externalEventSubscriptionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string", "enum": ["running", "success", "error", "queued"] } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventPullsPaginatedResponseDto" } } } } }, "summary": "List external event pulls", "tags": ["ExternalEventPulls"] } }, "/external-event-pulls/{id}": { "get": { "operationId": "getExternalEventPull", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventPullApiResponseDto" } } } } }, "summary": "Get external event pull", "tags": ["ExternalEventPulls"] } }, "/external-event-pulls/{id}/logs": { "get": { "operationId": "getExternalEventPullLogs", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementLogsResponseDto" } } } } }, "summary": "Get external event pull logs", "tags": ["ExternalEventPulls"] } }, "/external-event-pulls/{id}/telemetry": { "get": { "operationId": "getExternalEventPullTelemetry", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventPullTelemetryDto" } } } } }, "summary": "Get external event pull telemetry", "tags": ["ExternalEventPulls"] } }, "/external-event-subscriptions": { "get": { "operationId": "listExternalEventSubscriptions", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalEventTypeId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string", "enum": ["subscribed", "unsubscribed", "error"] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventSubscriptionsPaginatedResponseDto" } } } } }, "summary": "List external event subscriptions", "tags": ["ExternalEventSubscriptions"] }, "post": { "operationId": "createExternalEventSubscription", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExternalEventSubscriptionRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto" } } } } }, "summary": "Create external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{elementSelector}/dependencies": { "get": { "operationId": "getExternalEventSubscriptionDependencies", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of a external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{elementSelector}/refresh": { "post": { "operationId": "refreshExternalEventSubscription", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Refresh external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{elementSelector}/restore": { "post": { "operationId": "restoreExternalEventSubscription", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Restore (unarchive) external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{id}": { "get": { "operationId": "getExternalEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto" } } } } }, "summary": "Get external event subscription", "tags": ["ExternalEventSubscriptions"] }, "patch": { "operationId": "patchExternalEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchExternalEventSubscriptionRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto" } } } } }, "summary": "Patch editable fields on an external event subscription", "tags": ["ExternalEventSubscriptions"] }, "delete": { "operationId": "deleteExternalEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Delete external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{id}/download-full-sync-snapshot": { "post": { "operationId": "downloadExternalEventSubscriptionFullSyncSnapshot", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": {} } } } }, "summary": "Download full sync snapshot for external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{id}/pull-events": { "post": { "operationId": "pullExternalEventSubscriptionEvents", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventPullApiResponseDto" } } } } }, "summary": "Triggers pull events for external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{id}/refresh-webhook": { "post": { "operationId": "refreshExternalEventSubscriptionWebhook", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto" } } } } }, "summary": "Refresh webhook for external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{id}/resubscribe": { "post": { "operationId": "resubscribeToExternalEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto" } } } } }, "summary": "Resubscribe to external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{id}/setup": { "post": { "operationId": "setupExternalEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto" } } } } }, "summary": "Setup external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{id}/subscribe": { "post": { "operationId": "subscribeToExternalEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto" } } } } }, "summary": "Subscribe to external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-subscriptions/{id}/unsubscribe": { "post": { "operationId": "unsubscribeFromExternalEventSubscription", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto" } } } } }, "summary": "Unsubscribe from external event subscription", "tags": ["ExternalEventSubscriptions"] } }, "/external-event-types": { "get": { "operationId": "listExternalEventTypes", "parameters": [ { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "parentId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "universalParentId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isUniversal", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse" } } } } }, "summary": "List external event types", "tags": ["ExternalEventTypes"] }, "post": { "operationId": "createExternalEventType", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExternalEventType" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse" } } } } }, "summary": "Create a new external event type", "tags": ["ExternalEventTypes"] } }, "/external-event-types/{selector}": { "get": { "operationId": "getExternalEventType", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse" } } } } }, "summary": "Get external event type by selector", "tags": ["ExternalEventTypes"] }, "patch": { "operationId": "patchExternalEventType", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExternalEventType" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse" } } } } }, "summary": "Update external event type partially", "tags": ["ExternalEventTypes"] }, "put": { "operationId": "replaceExternalEventType", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExternalEventType" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse" } } } } }, "summary": "Replace external event type completely", "tags": ["ExternalEventTypes"] }, "delete": { "operationId": "archiveExternalEventType", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive external event type", "tags": ["ExternalEventTypes"] } }, "/external-event-types/{selector}/clone": { "post": { "operationId": "cloneExternalEventType", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse" } } } } }, "summary": "Clone external event type", "tags": ["ExternalEventTypes"] } }, "/external-event-types/{selector}/dependencies": { "get": { "operationId": "getExternalEventTypeDependencies", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of external event type (flat interface)", "tags": ["ExternalEventTypes"] } }, "/external-event-types/{selector}/export": { "get": { "operationId": "exportExternalEventType", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypeExportProperties" } } } } }, "summary": "Export external event type (flat interface)", "tags": ["ExternalEventTypes"] } }, "/external-event-types/{selector}/refresh": { "post": { "operationId": "refreshExternalEventType", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse" } } } } }, "summary": "Refresh external event type", "tags": ["ExternalEventTypes"] } }, "/external-event-types/{selector}/reset": { "post": { "description": "Refreshes all the dependencies, then resets the element to the default state (from parent)", "operationId": "resetExternalEventType", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse" } } } } }, "summary": "Reset external event type", "tags": ["ExternalEventTypes"] } }, "/external-event-types/{selector}/restore": { "post": { "operationId": "restoreExternalEventType", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse" } } } } }, "summary": "Restore external event type (flat interface)", "tags": ["ExternalEventTypes"] } }, "/field-mappings": { "get": { "operationId": "listFieldMappings", "parameters": [ { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "universalParentId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isUniversal", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "fieldMappingId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "universalFieldMappingId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse" } } } } }, "summary": "List field mappings", "tags": ["FieldMappings"] }, "post": { "operationId": "createFieldMapping", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFieldMapping" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingApiResponse" } } } } }, "summary": "Create a new field mapping", "tags": ["FieldMappings"] } }, "/field-mappings/{selector}": { "get": { "operationId": "getFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingApiResponse" } } } } }, "summary": "Get field mapping by selector", "tags": ["FieldMappings"] }, "patch": { "operationId": "patchFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFieldMapping" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingApiResponse" } } } } }, "summary": "Update field mapping partially", "tags": ["FieldMappings"] }, "put": { "operationId": "replaceFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFieldMapping" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingApiResponse" } } } } }, "summary": "Replace field mapping completely", "tags": ["FieldMappings"] }, "delete": { "operationId": "archiveFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive field mapping", "tags": ["FieldMappings"] } }, "/field-mappings/{selector}/app-schema": { "get": { "operationId": "getFieldMappingAppSchema", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingAppSchemaResponseDto" } } } } }, "summary": "Get field mapping app schema", "tags": ["FieldMappings"] } }, "/field-mappings/{selector}/clone": { "post": { "operationId": "cloneFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingApiResponse" } } } } }, "summary": "Clone field mapping", "tags": ["FieldMappings"] } }, "/field-mappings/{selector}/dependencies": { "get": { "operationId": "getFieldMappingDependencies", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of field mapping (flat interface)", "tags": ["FieldMappings"] } }, "/field-mappings/{selector}/export": { "get": { "operationId": "exportFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingExportProperties" } } } } }, "summary": "Export field mapping (flat interface)", "tags": ["FieldMappings"] } }, "/field-mappings/{selector}/refresh": { "post": { "operationId": "refreshFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingApiResponse" } } } } }, "summary": "Refresh field mapping", "tags": ["FieldMappings"] } }, "/field-mappings/{selector}/reset": { "post": { "description": "Refreshes all the dependencies, then resets the element to the default state (from parent)", "operationId": "resetFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingApiResponse" } } } } }, "summary": "Reset field mapping", "tags": ["FieldMappings"] } }, "/field-mappings/{selector}/restore": { "post": { "operationId": "restoreFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingApiResponse" } } } } }, "summary": "Restore field mapping (flat interface)", "tags": ["FieldMappings"] } }, "/field-mappings/{selector}/run": { "post": { "operationId": "runFieldMapping", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunFieldMappingRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunFieldMappingResponseDto" } } } } }, "summary": "Run a field mapping", "tags": ["FieldMappings"] } }, "/files": { "post": { "operationId": "uploadFile", "parameters": [], "requestBody": { "required": true, "description": "File binary data", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseDto" } } } } }, "summary": "Upload a file", "tags": ["Files"] } }, "/flow-runs": { "get": { "operationId": "listFlowRuns", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "flowId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "universalFlowId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationFlowId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionFlowId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "state", "required": false, "in": "query", "schema": { "type": "string", "enum": ["queued", "running", "completed", "stopped", "failed"] } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto" } } } } }, "summary": "List all flow runs", "tags": ["FlowRuns"] } }, "/flow-runs/{id}": { "get": { "operationId": "getFlowRun", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowRunApiResponseDto" } } } } }, "summary": "Get flow run by ID", "tags": ["FlowRuns"] } }, "/flow-runs/{id}/nodes/{nodeKey}/outputs": { "get": { "operationId": "getNodeRunOutputs", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "nodeKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "cursor", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowNodeRunOutputDto" } } } } }, "summary": "Get node run outputs", "tags": ["FlowRuns"] } }, "/flow-runs/{id}/nodes/{nodeKey}/outputs/{outputId}": { "get": { "operationId": "getNodeRunOutput", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "nodeKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "outputId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowNodeRunOutputResponseDto" } } } } }, "summary": "Get specific node run output", "tags": ["FlowRuns"] } }, "/flow-runs/{id}/nodes/{nodeKey}/runs": { "get": { "operationId": "getNodeRuns", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "nodeKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "cursor", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowNodeRunsDto" } } } } }, "summary": "Get node runs for flow run", "tags": ["FlowRuns"] } }, "/flow-runs/{id}/nodes/{nodeKey}/runs/{nodeRunId}": { "get": { "operationId": "getNodeRun", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "nodeKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "nodeRunId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowNodeRunRecordWithoutOutputsDataDto" } } } } }, "summary": "Get specific node run", "tags": ["FlowRuns"] } }, "/flow-runs/{id}/output": { "get": { "operationId": "getFlowRunOutput", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "cursor", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowRunOutputDto" } } } } }, "summary": "Get flow run output", "tags": ["FlowRuns"] } }, "/flow-runs/{id}/output/{nodeKey}": { "get": { "operationId": "getNodeOutput", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "nodeKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "cursor", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowRunOutputDto" } } } } }, "summary": "Get flow run output for specific node", "tags": ["FlowRuns"] } }, "/flow-runs/{id}/stop": { "post": { "operationId": "stopFlowRun", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "204": { "description": "" } }, "summary": "Stop flow run execution", "tags": ["FlowRuns"] } }, "/flows": { "get": { "operationId": "listFlows", "parameters": [ { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "universalParentId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isUniversal", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "flowId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "universalFlowId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowPaginatedResponse" } } } } }, "summary": "List flows", "tags": ["Flows"] }, "post": { "operationId": "createFlow", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFlow" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowApiResponse" } } } } }, "summary": "Create a new flow", "tags": ["Flows"] } }, "/flows/{selector}": { "get": { "operationId": "getFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowApiResponse" } } } } }, "summary": "Get flow by selector", "tags": ["Flows"] }, "patch": { "operationId": "patchFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFlow" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowApiResponse" } } } } }, "summary": "Update flow partially", "tags": ["Flows"] }, "put": { "operationId": "replaceFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFlow" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowApiResponse" } } } } }, "summary": "Replace flow completely", "tags": ["Flows"] }, "delete": { "operationId": "archiveFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive flow", "tags": ["Flows"] } }, "/flows/{selector}/clone": { "post": { "operationId": "cloneFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowApiResponse" } } } } }, "summary": "Clone flow", "tags": ["Flows"] } }, "/flows/{selector}/dependencies": { "get": { "operationId": "getFlowDependencies", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of flow (flat interface)", "tags": ["Flows"] } }, "/flows/{selector}/export": { "get": { "operationId": "exportFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowExportProperties" } } } } }, "summary": "Export flow (flat interface)", "tags": ["Flows"] } }, "/flows/{selector}/refresh": { "post": { "operationId": "refreshFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowApiResponse" } } } } }, "summary": "Refresh flow", "tags": ["Flows"] } }, "/flows/{selector}/reset": { "post": { "description": "Refreshes all the dependencies, then resets the element to the default state (from parent)", "operationId": "resetFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowApiResponse" } } } } }, "summary": "Reset flow", "tags": ["Flows"] } }, "/flows/{selector}/restore": { "post": { "operationId": "restoreFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowApiResponse" } } } } }, "summary": "Restore flow (flat interface)", "tags": ["Flows"] } }, "/flows/{selector}/run": { "post": { "operationId": "runFlow", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunFlowRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowRunDto" } } } } }, "summary": "Run a flow", "tags": ["RunFlow"] } }, "/import": { "post": { "operationId": "importWorkspace", "parameters": [ { "name": "dryRun", "required": true, "in": "query", "schema": { "type": "boolean" } }, { "name": "partial", "required": true, "in": "query", "schema": { "type": "boolean" } }, { "name": "diff", "required": true, "in": "query", "schema": { "type": "boolean" } }, { "name": "force", "required": true, "in": "query", "schema": { "type": "boolean" } }, { "name": "simplified", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Membrane workspace zip file" }, "dryRun": { "type": "boolean", "description": "Dry run import to see what changes would be made", "default": false } } } } } }, "responses": { "200": { "description": "The job id and access key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestTriggerResponseDto" } } } } }, "summary": "Import workspace elements from membrane zip file", "tags": ["ImportMembraneInterfaces"] } }, "/incoming-webhooks": { "get": { "operationId": "listIncomingWebhooks", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "subscriptionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string", "enum": ["success", "error"] } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto" } } } } }, "summary": "List incoming webhooks", "tags": ["IncomingWebhooksReader"] } }, "/incoming-webhooks/{id}": { "get": { "operationId": "getIncomingWebhook", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingWebhookDto" } } } } }, "summary": "Get incoming webhook by ID", "tags": ["IncomingWebhooksReader"] } }, "/incoming-webhooks/{id}/details": { "get": { "operationId": "getIncomingWebhookDetails", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingWebhookDetailsResponseDto" } } } } }, "summary": "Get incoming webhook details", "tags": ["IncomingWebhooksReader"] } }, "/integrations": { "get": { "operationId": "listIntegrations", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "connectorId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "appUuid", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectors", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "externalApps", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "websearch", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "all", "required": false, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto" } } } } }, "summary": "List all integrations", "tags": ["Integrations"] }, "post": { "operationId": "createIntegration", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIntegrationDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationApiResponseDto" } } } } }, "summary": "Create a new integration", "tags": ["Integrations"] } }, "/integrations/{elementSelector}/refresh": { "post": { "operationId": "refreshIntegration", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Refresh integration", "tags": ["Integrations"] } }, "/integrations/{elementSelector}/restore": { "post": { "operationId": "restoreIntegration", "parameters": [ { "name": "elementSelector", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseWorkspaceElementDto" } } } } }, "summary": "Restore (unarchive) integration", "tags": ["Integrations"] } }, "/integrations/{idOrKey}": { "get": { "operationId": "getIntegration", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "includeSecrets", "required": true, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationApiResponseDto" } } } } }, "summary": "Get integration by selector (id, uuid, or key)", "tags": ["Integrations"] } }, "/integrations/{idOrKey}/parameters": { "put": { "operationId": "setIntegrationParameters", "parameters": [ { "name": "idOrKey", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetIntegrationParametersDto" } } } }, "responses": { "204": { "description": "Operation completed successfully" } }, "summary": "Set integration parameters", "tags": ["Integrations"] } }, "/integrations/{id}": { "patch": { "operationId": "patchIntegration", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIntegrationDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationApiResponseDto" } } } } }, "summary": "Update integration partially", "tags": ["Integrations"] }, "put": { "operationId": "updateIntegration", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIntegrationDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationApiResponseDto" } } } } }, "summary": "Update integration completely", "tags": ["Integrations"] }, "delete": { "operationId": "archiveIntegration", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive an integration", "tags": ["Integrations"] } }, "/integrations/{id}/data": { "get": { "operationId": "getIntegrationDataLocations", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "List integration data locations", "tags": ["Integrations"] } }, "/integrations/{id}/data/{dataLocationKey}": { "get": { "operationId": "getIntegrationDataLocationByKey", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dataLocationKey", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "collectionParams", "required": false, "in": "query", "description": "Data Collection parameters", "style": "form", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCollectionSpecDto" } } } } }, "summary": "Get integration data location", "tags": ["Integrations"] } }, "/integrations/{id}/export": { "get": { "operationId": "exportIntegration", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationExportResponseDto" } } } } }, "summary": "Export integration by ID", "tags": ["Integrations"] } }, "/integrations/{id}/global-webhooks": { "get": { "operationId": "getIntegrationGlobalWebhooks", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "List integration global webhooks", "tags": ["Integrations"] } }, "/integrations/{id}/parameters": { "get": { "operationId": "getIntegrationParameters", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "default": { "type": "string" } }, "required": ["name", "type", "description", "required", "default"] } } } } } }, "summary": "Get integration parameters", "tags": ["Integrations"] } }, "/integrations/{id}/setup": { "post": { "operationId": "setupIntegration", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationApiResponseDto" } } } } }, "summary": "Setup integration configuration", "tags": ["Integrations"] } }, "/integrations/{id}/upload-connector": { "post": { "operationId": "uploadIntegrationConnector", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationApiResponseDto" } } } } }, "summary": "Upload connector to integration", "tags": ["Integrations"] } }, "/org-workspaces": { "post": { "operationId": "createOrgWorkspace", "parameters": [ { "name": "skipAddingCurrentUser", "required": true, "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWorkspaceCreateDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWorkspaceDto" } } } } }, "summary": "Create a workspace in an organization", "tags": ["OrgWorkspaces"], "x-experimental": true }, "get": { "operationId": "listOrgWorkspaces", "parameters": [ { "name": "search", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "orgId", "required": false, "in": "query", "description": "Filter by organization ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrgWorkspacesResponseDto" } } } } }, "summary": "List organization workspaces accessible to the current user", "tags": ["OrgWorkspaces"], "x-experimental": true } }, "/org-workspaces/import": { "post": { "operationId": "importOrgWorkspaces", "parameters": [ { "name": "sourceOrgWorkspaceId", "required": true, "in": "query", "schema": { "minLength": 1, "type": "string" } }, { "name": "targetOrgWorkspaceIds", "required": true, "in": "query", "schema": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "type": "string", "minLength": 1 } } ] } }, { "name": "dryRun", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "partial", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "diff", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "force", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "simplified", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWorkspacesImportResultDto" } } } } }, "summary": "Import a source workspace into one or more target workspaces", "tags": ["OrgWorkspacesTransfer"], "x-experimental": true } }, "/org-workspaces/{id}": { "get": { "operationId": "getOrgWorkspace", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWorkspaceDto" } } } } }, "summary": "Get an organization workspace", "tags": ["OrgWorkspaces"], "x-experimental": true }, "patch": { "operationId": "updateOrgWorkspace", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWorkspacePatchDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWorkspaceDto" } } } } }, "summary": "Update an organization workspace", "tags": ["OrgWorkspaces"], "x-experimental": true }, "delete": { "operationId": "archiveOrgWorkspace", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWorkspaceDto" } } } } }, "summary": "Archive an organization workspace", "tags": ["OrgWorkspaces"], "x-experimental": true } }, "/org-workspaces/{id}/access-token": { "post": { "operationId": "generateOrgWorkspaceAccessToken", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAccessTokenRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAccessTokenResponseDto" } } } } }, "summary": "Generate an access token for an organization workspace", "tags": ["OrgWorkspaces"], "x-experimental": true } }, "/org-workspaces/{id}/restore": { "post": { "operationId": "restoreOrgWorkspace", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWorkspaceDto" } } } } }, "summary": "Restore an archived organization workspace", "tags": ["OrgWorkspaces"], "x-experimental": true } }, "/org-workspaces/{id}/rotate-secret": { "post": { "operationId": "rotateOrgWorkspaceSecret", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateOrgWorkspaceSecretResponseDto" } } } } }, "summary": "Rotate the secret for an organization workspace", "tags": ["OrgWorkspaces"], "x-experimental": true } }, "/org-workspaces/{id}/user-settings": { "patch": { "operationId": "patchUserWorkspaceSettings", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchUserWorkspaceSettingsDto" } } } }, "responses": { "204": { "description": "" } }, "summary": "Update current user workspace settings", "tags": ["OrgWorkspaces"], "x-experimental": true } }, "/packages": { "get": { "operationId": "listPackages", "parameters": [ { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "Text search query to filter results", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "parentId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "universalParentId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "userId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isUniversal", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "externalAppId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackagesPaginatedResponseDto" } } } } }, "summary": "List packages", "tags": ["Packages"] }, "post": { "operationId": "createPackage", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePackage" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageApiResponse" } } } } }, "summary": "Create a new package", "tags": ["Packages"] } }, "/packages/{id}/versions": { "get": { "operationId": "getPackageVersions", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Package ID", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageVersionsResponseDto" } } } } }, "summary": "Get all versions of a package", "tags": ["Packages"] } }, "/packages/{selector}": { "get": { "operationId": "getPackage", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "version", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageApiResponseDto" } } } } }, "summary": "Get package by selector", "tags": ["Packages"] }, "patch": { "operationId": "patchPackage", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePackage" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageApiResponse" } } } } }, "summary": "Update package partially", "tags": ["Packages"] }, "put": { "operationId": "replacePackage", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePackage" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageApiResponse" } } } } }, "summary": "Replace package completely", "tags": ["Packages"] }, "delete": { "operationId": "archivePackage", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Archive package", "tags": ["Packages"] } }, "/packages/{selector}/clone": { "post": { "operationId": "clonePackage", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageApiResponse" } } } } }, "summary": "Clone package", "tags": ["Packages"] } }, "/packages/{selector}/dependencies": { "get": { "operationId": "getPackageDependencies", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "summary": "Get dependencies of package (flat interface)", "tags": ["Packages"] } }, "/packages/{selector}/export": { "get": { "operationId": "exportPackage", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageExportProperties" } } } } }, "summary": "Export package (flat interface)", "tags": ["Packages"] } }, "/packages/{selector}/refresh": { "post": { "operationId": "refreshPackage", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageApiResponse" } } } } }, "summary": "Refresh package", "tags": ["Packages"] } }, "/packages/{selector}/reset": { "post": { "description": "Refreshes all the dependencies, then resets the element to the default state (from parent)", "operationId": "resetPackage", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageApiResponse" } } } } }, "summary": "Reset package", "tags": ["Packages"] } }, "/packages/{selector}/restore": { "post": { "operationId": "restorePackage", "parameters": [ { "name": "selector", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "layer", "required": false, "in": "query", "schema": { "type": "string", "enum": ["universal", "integration", "connection"] } }, { "name": "integrationKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "integrationId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "connectionKey", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "instanceKey", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageApiResponse" } } } } }, "summary": "Restore package (flat interface)", "tags": ["Packages"] } }, "/search": { "get": { "operationId": "searchWorkspaceElements", "parameters": [ { "name": "q", "required": true, "in": "query", "schema": { "minLength": 1, "maxLength": 200, "type": "string" } }, { "name": "elementType", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 100, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponseDto" } } } } }, "summary": "Search workspace elements by keyword", "tags": ["WorkspaceElementsSearch"] } }, "/semantic-search": { "get": { "operationId": "semanticSearchWorkspaceElements", "parameters": [ { "name": "q", "required": true, "in": "query", "schema": { "minLength": 1, "maxLength": 200, "type": "string" } }, { "name": "elementType", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 100, "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticSearchResponseDto" } } } } }, "summary": "Search workspace elements using semantic similarity", "tags": ["WorkspaceElementsSearch"] } }, "/universe/apps": { "get": { "operationId": "listPublicApps", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "category", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "isConnected", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppsPaginatedResponseDto" } } } } }, "summary": "List public apps", "tags": ["AppsUniverse"] } }, "/universe/connectors": { "get": { "operationId": "listPublicConnectors", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "includeArchived", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto" } } } } }, "summary": "List public Membrane connectors", "tags": ["ConnectorsUniverse"] } }, "/universe/packages": { "get": { "operationId": "listPublicPackages", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPackagesPaginatedResponseDto" } } } } }, "summary": "List public packages", "tags": ["PackagesUniverse"] } }, "/v2/universe/apps": { "get": { "operationId": "listPublicExternalApps", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of items to return (1-1000)", "schema": { "minimum": 1, "maximum": 1000, "type": "integer" } }, { "name": "cursor", "required": false, "in": "query", "description": "Pagination cursor from a previous response", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "category", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "hasData", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppsPaginatedV2ResponseDto" } } } } }, "summary": "List public External Apps with authentication support", "tags": ["Universe"] } } }, "info": { "title": "Membrane API", "description": "API documentation for Membrane Engine", "version": "1.0", "contact": {} }, "tags": [], "servers": [ { "url": "https://api.getmembrane.com" } ], "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } }, "schemas": { "ActRequestDto": { "type": "object", "properties": { "id": { "description": "ID of the action to run.", "type": "string" }, "key": { "description": "Key of the action to run. If the same key exists across multiple integrations, also pass `integrationId`, `integrationKey`, or `connectionId` so we know which one you mean.", "type": "string" }, "api": { "description": "Inline HTTP request spec, sent through the resolved connection's auth layer and base URL. Pair with `connectionId`, `connectionKey`, `integrationId`, or `integrationKey` to pick the connection.", "type": "object", "properties": { "method": { "type": "string", "enum": ["GET", "POST", "PATCH", "PUT", "DELETE"], "description": "HTTP method to use." }, "path": { "description": "Path appended to the connection's base URL, e.g. `/v2/users/me`. Required.", "type": "string" }, "body": { "description": "Request body. For JSON APIs, pass a plain object." }, "headers": { "description": "Additional HTTP headers.", "type": "object", "additionalProperties": { "type": "string" } }, "query": { "description": "Query-string parameters.", "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": ["method"] }, "code": { "description": "Inline JavaScript executed in a sandbox. The module must export a function that receives `{ input, membrane, ... }`. Its return value becomes the action output.", "type": "string" }, "integrationId": { "description": "ID of the integration to run the action on. When `key` is provided, looks up the action within this integration. When no connection is specified, runs against this integration's default connection.", "type": "string" }, "integrationKey": { "description": "Key of the integration to run the action on. When `key` is provided, looks up the action within this integration. When no connection is specified, runs against this integration's default connection.", "type": "string" }, "connectionId": { "description": "ID of the connection to run the action against. If a connection-level version of the action exists on this connection, that version is used; otherwise the integration-level or universal action is used.", "type": "string" }, "connectionKey": { "description": "Key of the connection to run the action against. Use when you have a stable key for the connection instead of an ID.", "type": "string" }, "input": { "description": "Input passed to the action, matching its input schema." }, "meta": { "description": "Arbitrary metadata stored on the action run log.", "type": "object", "additionalProperties": { "type": "object" } } }, "additionalProperties": false }, "ActResponseDto": { "type": "object", "properties": { "output": { "type": "object" }, "actionRunId": { "type": "string" } } }, "ActionApiResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "parent": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "description": "Resolved output schema (cached after setup). Derived from customOutputSchema, transformed schema from outputMapping, default output schema, or parent custom output schema. Read-only." }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" } }, "required": ["id", "name"] }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "description": "Resolved output schema (cached after setup). Derived from customOutputSchema, transformed schema from outputMapping, default output schema, or parent custom output schema. Read-only." }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } }, "defaultOutputSchema": { "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "transformedOutputSchema": { "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] }, "ActionApiResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "parent": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "description": "Resolved output schema (cached after setup). Derived from customOutputSchema, transformed schema from outputMapping, default output schema, or parent custom output schema. Read-only." }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" } }, "required": ["id", "name"] }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "description": "Resolved output schema (cached after setup). Derived from customOutputSchema, transformed schema from outputMapping, default output schema, or parent custom output schema. Read-only." }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } }, "defaultOutputSchema": { "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "transformedOutputSchema": { "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] }, "ActionApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ActionApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ActionApiResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ActionApiResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/ActionApiResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ActionApiResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ActionApiResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ActionApiResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ActionApiResponse__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ActionApiResponse__schema1" } }, "items": { "$ref": "#/components/schemas/ActionApiResponse__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ActionApiResponse__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ActionApiResponse__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ActionExportProperties": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationUuid": { "type": "string" }, "parentUuid": { "type": "string" }, "externalAppUuid": { "type": "string" }, "isCustomized": { "type": "boolean" }, "isUniversal": { "type": "boolean" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionExportProperties__schema0" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionExportProperties__schema0" } }, "required": ["uuid", "key"] }, "ActionExportProperties__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ActionExportProperties__schema0" } }, "items": { "$ref": "#/components/schemas/ActionExportProperties__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ActionExportProperties__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ActionExportProperties__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ActionRunLogRecordApiResponseDto": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string", "description": "Deprecated: Read from action.connectionId or action.connectionKey instead", "deprecated": true }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "universalActionId": { "type": "string" }, "integrationActionId": { "type": "string" }, "connectionActionId": { "type": "string" }, "input": { "description": "Deprecated: Read from action.input instead", "deprecated": true, "type": "object" }, "output": { "type": "object" }, "status": { "type": "string", "enum": ["success", "error"] }, "createdAt": { "type": "string" }, "completedAt": { "type": "string" }, "error": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema0" }, "duration": { "type": "number" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "action": { "description": "Complete /act-body snapshot of what ran — sufficient to replay the run by POSTing back to /act.", "type": "object", "properties": { "id": { "type": "string" }, "integrationKey": { "type": "string" }, "key": { "type": "string" }, "connectionKey": { "type": "string" }, "connectionId": { "type": "string" }, "type": { "type": "string" }, "api": { "type": "object", "properties": { "method": { "type": "string", "enum": ["GET", "POST", "PATCH", "PUT", "DELETE"] }, "path": { "type": "string" }, "url": { "type": "string" }, "body": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "query": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": ["method"] }, "code": { "type": "string" }, "input": { "type": "object" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } } }, "required": ["type"] }, "actionInstance": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "description": "Resolved output schema (cached after setup). Derived from customOutputSchema, transformed schema from outputMapping, default output schema, or parent custom output schema. Read-only." }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] } }, "required": [ "userId", "id", "integrationId", "connectionId", "name", "integrationActionId", "status", "createdAt" ] }, "ActionRunLogRecordApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ActionRunLogRecordApiResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ActionRunLogRecordApiResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ActionRunLogRecordInDb": { "type": "object", "properties": {} }, "ActionRunLogRecordsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string", "description": "Deprecated: Read from action.connectionId or action.connectionKey instead", "deprecated": true }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "universalActionId": { "type": "string" }, "integrationActionId": { "type": "string" }, "connectionActionId": { "type": "string" }, "input": { "description": "Deprecated: Read from action.input instead", "deprecated": true, "type": "object" }, "output": { "type": "object" }, "status": { "type": "string", "enum": ["success", "error"] }, "createdAt": { "type": "string" }, "completedAt": { "type": "string" }, "error": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema0" }, "duration": { "type": "number" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "action": { "description": "Complete /act-body snapshot of what ran — sufficient to replay the run by POSTing back to /act.", "type": "object", "properties": { "id": { "type": "string" }, "integrationKey": { "type": "string" }, "key": { "type": "string" }, "connectionKey": { "type": "string" }, "connectionId": { "type": "string" }, "type": { "type": "string" }, "api": { "type": "object", "properties": { "method": { "type": "string", "enum": ["GET", "POST", "PATCH", "PUT", "DELETE"] }, "path": { "type": "string" }, "url": { "type": "string" }, "body": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "query": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": ["method"] }, "code": { "type": "string" }, "input": { "type": "object" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } } }, "required": ["type"] }, "actionInstance": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "description": "Resolved output schema (cached after setup). Derived from customOutputSchema, transformed schema from outputMapping, default output schema, or parent custom output schema. Read-only." }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] } }, "required": [ "userId", "id", "integrationId", "connectionId", "name", "integrationActionId", "status", "createdAt" ] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ActionRunLogRecordsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ActionRunLogRecordsPaginatedResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ActionRunLogRecordsPaginatedResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ActionRunRequestDto": { "type": "object", "properties": { "input": { "description": "Input data for the action, matching the action inputSchema" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ActionRunResponseDto": { "type": "object", "properties": { "output": { "type": "object" }, "actionRunId": { "type": "string" } } }, "ActionsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "parent": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "description": "Resolved output schema (cached after setup). Derived from customOutputSchema, transformed schema from outputMapping, default output schema, or parent custom output schema. Read-only." }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" } }, "required": ["id", "name"] }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "universalParentId": { "description": "For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.", "type": "string" }, "outputSchema": { "description": "Resolved output schema (cached after setup). Derived from customOutputSchema, transformed schema from outputMapping, default output schema, or parent custom output schema. Read-only." }, "isPublic": { "description": "When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.", "type": "boolean" } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } }, "defaultOutputSchema": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "transformedOutputSchema": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ActionsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ActionsPaginatedResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ActionsPaginatedResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "AgentSessionDto": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "workspaceId": { "type": "string" }, "orgWorkspaceId": { "type": "string" }, "workspaceElementType": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "workspaceElementId": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string", "enum": ["queued", "starting", "running", "completed", "failed", "cancelled"] }, "prompt": { "type": "string" }, "error": { "$ref": "#/components/schemas/AgentSessionDto__schema0" }, "lastActivityAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "description": "Last meaningful session progress timestamp used for inactivity timeout checks." }, "title": { "type": "string" }, "summary": { "type": "string" }, "cost": { "type": "number" }, "state": { "default": "busy", "type": "string", "enum": ["busy", "idle"] }, "hasWorker": { "type": "boolean" }, "isExternal": { "type": "boolean" }, "agentName": { "type": "string", "enum": [ "membrane", "membrane-core", "self-integrating", "connection-building", "action-building", "universe" ] }, "agentHarnessId": { "type": "string" }, "agentHarnessSnapshotId": { "type": "string" }, "output": { "type": "object", "additionalProperties": { "type": "object" } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "workspaceId", "type", "status", "prompt", "lastActivityAt", "hasWorker", "createdAt", "updatedAt" ] }, "AgentSessionDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AgentSessionDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AgentSessionInputDto": { "type": "object", "properties": { "input": { "type": "string", "minLength": 1 }, "synthetic": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "data": { "type": "object" } }, "required": ["title", "data"] } } }, "required": ["input"] }, "AgentSessionInterruptResponseDto": { "type": "object", "properties": { "interrupted": { "type": "boolean" } }, "required": ["interrupted"] }, "AgentSessionsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "workspaceId": { "type": "string" }, "orgWorkspaceId": { "type": "string" }, "workspaceElementType": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "workspaceElementId": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string", "enum": ["queued", "starting", "running", "completed", "failed", "cancelled"] }, "prompt": { "type": "string" }, "error": { "$ref": "#/components/schemas/AgentSessionsPaginatedResponseDto__schema0" }, "lastActivityAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "description": "Last meaningful session progress timestamp used for inactivity timeout checks." }, "title": { "type": "string" }, "summary": { "type": "string" }, "cost": { "type": "number" }, "state": { "default": "busy", "type": "string", "enum": ["busy", "idle"] }, "hasWorker": { "type": "boolean" }, "isExternal": { "type": "boolean" }, "agentName": { "type": "string", "enum": [ "membrane", "membrane-core", "self-integrating", "connection-building", "action-building", "universe" ] }, "agentHarnessId": { "type": "string" }, "agentHarnessSnapshotId": { "type": "string" }, "output": { "type": "object", "additionalProperties": { "type": "object" } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "workspaceId", "type", "status", "prompt", "lastActivityAt", "hasWorker", "createdAt", "updatedAt" ] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "AgentSessionsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AgentSessionsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AppDataSchemaCreateDto": { "type": "object", "properties": { "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "key": { "type": "string" }, "uuid": { "type": "string" }, "description": { "type": "string" }, "schema": { "type": "object" }, "code": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["name", "key"] }, "AppDataSchemaDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppDataSchemaDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "instanceKey": { "type": "string" }, "appDataSchemaId": { "type": "string" }, "schema": { "type": "object" }, "code": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "appDataSchemaRevision": { "type": "string" }, "isCustomized": { "type": "boolean" }, "error": { "$ref": "#/components/schemas/AppDataSchemaDto__schema0" }, "user": { "type": "object" }, "appDataSchema": { "type": "object" } }, "required": ["id", "name"] }, "AppDataSchemaDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AppDataSchemaDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AppDataSchemaExportDto": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "uuid": { "type": "string" }, "schema": { "type": "object" }, "code": { "type": "string" } }, "required": ["name"] }, "AppDataSchemaUpdateDto": { "type": "object", "properties": { "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "key": { "type": "string" }, "uuid": { "type": "string" }, "description": { "type": "string" }, "schema": { "type": "object" }, "code": { "type": "string" }, "archivedAt": { "type": "string" } } }, "AppDataSchemasPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppDataSchemasPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "instanceKey": { "type": "string" }, "appDataSchemaId": { "type": "string" }, "schema": { "type": "object" }, "code": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "appDataSchemaRevision": { "type": "string" }, "isCustomized": { "type": "boolean" }, "error": { "$ref": "#/components/schemas/AppDataSchemasPaginatedResponseDto__schema0" }, "user": { "type": "object" }, "appDataSchema": { "type": "object" } }, "required": ["id", "name"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "AppDataSchemasPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AppDataSchemasPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AppEventLogRecordApiResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "appEventTypeId": { "type": "string" }, "appEventType": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "webhookKey": { "type": "string" }, "subscribeRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "example": { "type": "object" }, "schema": { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto__schema1" }, "globalWebhookUri": { "type": "string" }, "tenantIdFormula": { "type": "object" }, "userIdFormula": { "type": "object" } }, "required": ["id", "name", "revision", "webhookKey", "globalWebhookUri"] }, "appEventSubscriptionId": { "type": "string" }, "appEventSubscription": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "appEventTypeId": { "type": "string" }, "instanceKey": { "type": "string" }, "isSubscribed": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto__schema1" }, "webhookUri": { "type": "string" }, "subscriptionRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "subscriptionResponse": { "type": "object" } }, "required": [ "id", "name", "revision", "userId", "appEventTypeId", "isSubscribed", "webhookUri", "subscriptionRequest" ] }, "event": { "type": "object" }, "datetime": { "type": "string" }, "launchedFlowRunIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "userId", "appEventTypeId", "appEventSubscriptionId", "event", "datetime", "launchedFlowRunIds" ] }, "AppEventLogRecordApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AppEventLogRecordApiResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/AppEventLogRecordApiResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "AppEventLogRecordsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "appEventTypeId": { "type": "string" }, "appEventType": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "webhookKey": { "type": "string" }, "subscribeRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "example": { "type": "object" }, "schema": { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto__schema1" }, "globalWebhookUri": { "type": "string" }, "tenantIdFormula": { "type": "object" }, "userIdFormula": { "type": "object" } }, "required": ["id", "name", "revision", "webhookKey", "globalWebhookUri"] }, "appEventSubscriptionId": { "type": "string" }, "appEventSubscription": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "appEventTypeId": { "type": "string" }, "instanceKey": { "type": "string" }, "isSubscribed": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto__schema1" }, "webhookUri": { "type": "string" }, "subscriptionRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "subscriptionResponse": { "type": "object" } }, "required": [ "id", "name", "revision", "userId", "appEventTypeId", "isSubscribed", "webhookUri", "subscriptionRequest" ] }, "event": { "type": "object" }, "datetime": { "type": "string" }, "launchedFlowRunIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "userId", "appEventTypeId", "appEventSubscriptionId", "event", "datetime", "launchedFlowRunIds" ] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "AppEventLogRecordsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AppEventLogRecordsPaginatedResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/AppEventLogRecordsPaginatedResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "AppEventSubscriptionApiResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "appEventTypeId": { "type": "string" }, "instanceKey": { "type": "string" }, "isSubscribed": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto__schema1" }, "webhookUri": { "type": "string" }, "subscriptionRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "subscriptionResponse": { "type": "object" }, "appEventType": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "webhookKey": { "type": "string" }, "subscribeRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "example": { "type": "object" }, "schema": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto__schema1" }, "globalWebhookUri": { "type": "string" }, "tenantIdFormula": { "type": "object" }, "userIdFormula": { "type": "object" } }, "required": ["id", "name", "revision", "webhookKey", "globalWebhookUri"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] } }, "required": [ "id", "name", "revision", "userId", "appEventTypeId", "isSubscribed", "webhookUri", "subscriptionRequest" ] }, "AppEventSubscriptionApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AppEventSubscriptionApiResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/AppEventSubscriptionApiResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "AppEventSubscriptionSchemaResponseDto": { "type": "object", "properties": {} }, "AppEventSubscriptionUpdateDto": { "type": "object", "properties": { "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "AppEventSubscriptionsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "appEventTypeId": { "type": "string" }, "instanceKey": { "type": "string" }, "isSubscribed": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto__schema1" }, "webhookUri": { "type": "string" }, "subscriptionRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "subscriptionResponse": { "type": "object" }, "appEventType": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "webhookKey": { "type": "string" }, "subscribeRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "example": { "type": "object" }, "schema": { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto__schema1" }, "globalWebhookUri": { "type": "string" }, "tenantIdFormula": { "type": "object" }, "userIdFormula": { "type": "object" } }, "required": ["id", "name", "revision", "webhookKey", "globalWebhookUri"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] } }, "required": [ "id", "name", "revision", "userId", "appEventTypeId", "isSubscribed", "webhookUri", "subscriptionRequest" ] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "AppEventSubscriptionsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AppEventSubscriptionsPaginatedResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/AppEventSubscriptionsPaginatedResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "AppEventTypeApiResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "webhookKey": { "type": "string" }, "subscribeRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "example": { "type": "object" }, "schema": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto__schema1" }, "globalWebhookUri": { "type": "string" }, "tenantIdFormula": { "type": "object" }, "userIdFormula": { "type": "object" } }, "required": ["id", "name", "revision", "webhookKey", "globalWebhookUri"] }, "AppEventTypeApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AppEventTypeApiResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/AppEventTypeApiResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/AppEventTypeApiResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "AppEventTypeExportDto": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "uuid": { "type": "string" }, "example": { "type": "object" }, "schema": { "type": "object" }, "subscribeRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "string" }, "body": { "type": "object" }, "query": { "type": "object" }, "headers": { "type": "object" } }, "required": ["uri"] }, "tenantIdFormula": { "type": "object" }, "userIdFormula": { "type": "object" } }, "required": ["name", "uuid"] }, "AppEventTypesPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/AppEventTypesPaginatedResponseDto__schema0" } }, "revision": { "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "webhookKey": { "type": "string" }, "subscribeRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "object" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object" } }, "required": ["uri"] }, "example": { "type": "object" }, "schema": { "$ref": "#/components/schemas/AppEventTypesPaginatedResponseDto__schema1" }, "globalWebhookUri": { "type": "string" }, "tenantIdFormula": { "type": "object" }, "userIdFormula": { "type": "object" } }, "required": ["id", "name", "revision", "webhookKey", "globalWebhookUri"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "AppEventTypesPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/AppEventTypesPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "AppEventTypesPaginatedResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AppEventTypesPaginatedResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/AppEventTypesPaginatedResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/AppEventTypesPaginatedResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/AppEventTypesPaginatedResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "AsyncRequestTriggerResponseDto": { "type": "object", "properties": { "jobId": { "type": "string" }, "accessKey": { "type": "string" } }, "required": ["jobId", "accessKey"] }, "BaseWorkspaceElementDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] }, "CheckpointApiResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "elementType": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "elementId": { "type": "string" }, "checkpointNumber": { "type": "number" }, "snapshot": { "type": "object", "additionalProperties": { "type": "object" } }, "createdAt": { "type": "string" }, "asyncRequestId": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "object" } } }, "required": ["id", "elementType", "elementId", "checkpointNumber", "snapshot", "createdAt"] }, "CheckpointDiffResponseDto": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": ["add", "remove", "replace"] }, "path": { "type": "string", "description": "Dot/bracket path, e.g. name, nodes[0].id" }, "value": { "type": "object" }, "oldValue": { "type": "object" } }, "required": ["op", "path"] } }, "CloneConnectorDto": { "type": "object", "properties": { "version": { "type": "string" } } }, "ConnectedProductApiResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string", "enum": ["ai-agent", "app"] }, "audience": { "type": "string", "enum": ["personal", "customers"] }, "parameters": { "type": "object", "properties": { "agentType": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "isConnected": { "type": "boolean" }, "lastApiRequestDate": { "type": "string" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "key", "type"] }, "ConnectedProductsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string", "enum": ["ai-agent", "app"] }, "audience": { "type": "string", "enum": ["personal", "customers"] }, "parameters": { "type": "object", "properties": { "agentType": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "isConnected": { "type": "boolean" }, "lastApiRequestDate": { "type": "string" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "key", "type"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ConnectionApiResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionApiResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ConnectionApiResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ConnectionApiResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ConnectionApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "connectorParameters": { "type": "object" }, "input": { "type": "object" } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "ConnectionApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ConnectionApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ConnectionExportDto": { "type": "object", "properties": { "type": { "type": "string", "enum": ["connector", "mcp"] }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "authOptionKey": { "type": "string" }, "key": { "type": "string", "minLength": 1, "maxLength": 100, "nullable": true }, "integrationUuid": { "type": "string" }, "connectorUuid": { "type": "string" }, "externalAppUuid": { "type": "string" } } }, "ConnectionTestResponseDto": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": ["success"] }, "ConnectionsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsPaginatedResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ConnectionsPaginatedResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ConnectionsPaginatedResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "connectorParameters": { "type": "object" }, "input": { "type": "object" }, "credentials": { "type": "object" } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ConnectionsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ConnectionsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ConnectorDownloadResponseDto": { "type": "object", "properties": { "data": { "type": "string", "description": "Binary file content" } }, "required": ["data"] }, "ConnectorDto": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "uuid": { "type": "string" }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "logoUri": { "type": "string" }, "appUri": { "description": "Site URL of the linked external app, denormalized onto public connector listings.", "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "isPublic": { "type": "boolean" }, "popularity": { "type": "number" }, "tenantId": { "type": "string" }, "archivedAt": { "description": "When set, the connector is archived (soft-deleted).", "type": "string" }, "baseUri": { "type": "string" }, "revision": { "type": "string" }, "dataCollectionsCount": { "type": "number" }, "operationsCount": { "type": "number" }, "eventsCount": { "type": "number" }, "udms": { "type": "array", "items": { "type": "string" } }, "hasTest": { "type": "boolean" }, "hasAuthTest": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "hasData": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "version": { "type": "string" }, "credentialsSchema": { "$ref": "#/components/schemas/ConnectorDto__schema0" }, "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/ConnectorDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/ConnectorDto__schema0" }, "parametersSchema": { "$ref": "#/components/schemas/ConnectorDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "options": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/ConnectorDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/ConnectorDto__schema0" }, "parametersSchema": { "description": "JSON Schema for connector-level parameters configured per integration (e.g. region, account ID).", "$ref": "#/components/schemas/ConnectorDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "ui": { "description": "[INTERNAL] Deprecated: Use inputSchema instead", "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ConnectorDto__schema0" }, "description": { "type": "string" }, "helpUri": { "type": "string" } } }, "title": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "object" }, "credentialsSchema": { "$ref": "#/components/schemas/ConnectorDto__schema0" } } } } }, "required": ["id", "key", "uuid", "name", "logoUri", "version"] }, "ConnectorDto__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConnectorDto__schema0" } }, "items": { "$ref": "#/components/schemas/ConnectorDto__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ConnectorDto__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorDto__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ConnectorExportPropertiesDto": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "logoUri": { "type": "string" }, "externalAppUuid": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" }, "parametersSchema": { "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "options": { "description": "Map of auth option key to auth configuration, for connectors that support multiple auth methods. Mutually exclusive with the top-level auth fields: use either the top-level fields (single-auth) OR `options` (multi-auth), not both.", "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" }, "parametersSchema": { "description": "JSON Schema for connector-level parameters configured per integration (e.g. region, account ID).", "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "ui": { "description": "[INTERNAL] Deprecated: Use inputSchema instead", "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" }, "description": { "type": "string" }, "helpUri": { "type": "string" } } }, "title": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "object" } } } }, "uuid": { "type": "string" } }, "required": ["key", "uuid"] }, "ConnectorExportPropertiesDto__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" } }, "items": { "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorExportPropertiesDto__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ConnectorVersionDto": { "type": "object", "properties": { "baseUri": { "type": "string" }, "revision": { "type": "string" }, "dataCollectionsCount": { "type": "number" }, "operationsCount": { "type": "number" }, "eventsCount": { "type": "number" }, "udms": { "type": "array", "items": { "type": "string" } }, "hasTest": { "type": "boolean" }, "hasAuthTest": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "hasData": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "version": { "type": "string" }, "credentialsSchema": { "$ref": "#/components/schemas/ConnectorVersionDto__schema0" }, "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/ConnectorVersionDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/ConnectorVersionDto__schema0" }, "parametersSchema": { "$ref": "#/components/schemas/ConnectorVersionDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "options": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/ConnectorVersionDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/ConnectorVersionDto__schema0" }, "parametersSchema": { "description": "JSON Schema for connector-level parameters configured per integration (e.g. region, account ID).", "$ref": "#/components/schemas/ConnectorVersionDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "ui": { "description": "[INTERNAL] Deprecated: Use inputSchema instead", "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ConnectorVersionDto__schema0" }, "description": { "type": "string" }, "helpUri": { "type": "string" } } }, "title": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "object" }, "credentialsSchema": { "$ref": "#/components/schemas/ConnectorVersionDto__schema0" } } } }, "id": { "type": "string" }, "connectorId": { "type": "string" }, "changelog": { "type": "string" } }, "required": ["version", "id", "connectorId", "changelog"] }, "ConnectorVersionDto__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConnectorVersionDto__schema0" } }, "items": { "$ref": "#/components/schemas/ConnectorVersionDto__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ConnectorVersionDto__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorVersionDto__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ConnectorsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "cursor": { "type": "string" } }, "required": ["items"] }, "CreateAction": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/CreateAction__schema0" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/CreateAction__schema0" }, "intent": { "description": "[Experimental] Intent-based instruction for an agent to configure this element.", "type": "string" } } }, "CreateAction__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CreateAction__schema0" } }, "items": { "$ref": "#/components/schemas/CreateAction__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/CreateAction__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/CreateAction__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "CreateAgentSessionDto": { "type": "object", "properties": { "workspaceElementType": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "workspaceElementId": { "type": "string", "minLength": 1 }, "prompt": { "type": "string", "minLength": 1 }, "testCustomerId": { "type": "string" }, "isExternal": { "type": "boolean" }, "modelId": { "type": "string", "enum": [ "anthropic/claude-sonnet-4.6", "anthropic/claude-opus-4.6", "anthropic/claude-sonnet-4.5", "anthropic/claude-opus-4.5", "anthropic/claude-haiku-4.5", "openai/gpt-5.2", "openai/gpt-5-nano", "google/gemini-3-pro-preview", "moonshotai/kimi-k2.5" ] }, "agentName": { "type": "string", "enum": [ "membrane", "membrane-core", "self-integrating", "connection-building", "action-building", "universe" ] }, "agentHarnessId": { "type": "string", "minLength": 1 }, "promptAttachments": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "data": { "type": "object" } }, "required": ["title", "data"] } } }, "required": ["prompt"] }, "CreateAppEventTypeDto": { "type": "object", "properties": { "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "key": { "type": "string" }, "uuid": { "type": "string" }, "description": { "type": "string" }, "schema": { "type": "object" }, "example": { "type": "object" }, "tenantIdFormula": { "type": "object" }, "userIdFormula": { "type": "object" }, "subscribeRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "string" }, "body": { "type": "object" }, "query": { "type": "object" }, "headers": { "type": "object" } }, "required": ["uri"] } }, "required": ["name", "key"] }, "CreateConnectedProductRequestDto": { "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string", "enum": ["ai-agent", "app"] }, "audience": { "type": "string", "enum": ["personal", "customers"] }, "parameters": { "type": "object", "properties": { "agentType": { "type": "string" } }, "additionalProperties": { "type": "object" } } }, "required": ["name", "type"] }, "CreateConnectionDto": { "type": "object", "properties": { "type": { "type": "string", "enum": ["connector", "mcp"] }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "authOptionKey": { "type": "string" }, "key": { "type": "string", "minLength": 1, "maxLength": 100, "nullable": true }, "integrationId": { "type": "string" }, "integrationUuid": { "type": "string" }, "integrationKey": { "type": "string" }, "connectorId": { "type": "string" }, "connectorUuid": { "type": "string" }, "connectorKey": { "type": "string" }, "connectorVersion": { "type": "string" }, "externalAppId": { "type": "string" }, "externalAppUuid": { "type": "string" }, "credentials": { "type": "object" }, "connectorParameters": { "type": "object" }, "input": { "type": "object" }, "intent": { "type": "string", "description": "[Experimental] Intent-based instruction for an agent to configure this element." } } }, "CreateConnectorDto": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "logoUri": { "type": "string" }, "externalAppId": { "type": "string" }, "externalAppUuid": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/CreateConnectorDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/CreateConnectorDto__schema0" }, "parametersSchema": { "$ref": "#/components/schemas/CreateConnectorDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "options": { "description": "Map of auth option key to auth configuration, for connectors that support multiple auth methods. Mutually exclusive with the top-level auth fields: use either the top-level fields (single-auth) OR `options` (multi-auth), not both.", "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/CreateConnectorDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/CreateConnectorDto__schema0" }, "parametersSchema": { "description": "JSON Schema for connector-level parameters configured per integration (e.g. region, account ID).", "$ref": "#/components/schemas/CreateConnectorDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "ui": { "description": "[INTERNAL] Deprecated: Use inputSchema instead", "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CreateConnectorDto__schema0" }, "description": { "type": "string" }, "helpUri": { "type": "string" } } }, "title": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "object" } } } }, "uuid": { "type": "string" } }, "required": ["name"] }, "CreateConnectorDto__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CreateConnectorDto__schema0" } }, "items": { "$ref": "#/components/schemas/CreateConnectorDto__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/CreateConnectorDto__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/CreateConnectorDto__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "CreateCustomerRequestDto": { "type": "object", "properties": { "name": { "type": "string" }, "internalId": { "type": "string" }, "fields": { "type": "object" }, "credentials": { "type": "object" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true } }, "required": ["name"] }, "CreateDataLinkDto": { "type": "object", "properties": { "direction": { "type": "string", "enum": ["import", "export", "both"] }, "appRecordId": { "type": "string" }, "externalRecordId": { "type": "string" } }, "required": ["direction", "appRecordId", "externalRecordId"] }, "CreateDataLinkTableDto": { "type": "object", "properties": { "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "key": { "type": "string" }, "uuid": { "type": "string" }, "description": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["name", "key"] }, "CreateDataSource": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "dataSourceId": { "type": "string" }, "universalDataSourceId": { "type": "string" }, "udm": { "type": "string" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "collectionKey": { "type": "string" }, "collectionParameters": { "type": "object" }, "path": { "deprecated": true, "type": "string" }, "defaultPath": { "deprecated": true, "type": "string" } } }, "CreateExternalAppDto": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "description": "Machine key (e.g., \"attio\"). Unique per workspace." }, "name": { "type": "string", "minLength": 1, "description": "Human-readable app name (e.g., \"Attio\")." }, "appUri": { "type": "string", "description": "App's main URL (e.g., \"https://attio.com\").", "format": "uri" }, "logoUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" } }, "required": ["key", "name"] }, "CreateExternalEventSubscriptionRequestDto": { "type": "object", "properties": { "connectionId": { "type": "string" }, "externalEventTypeId": { "type": "string" } }, "required": ["connectionId", "externalEventTypeId"] }, "CreateExternalEventType": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "schema": { "$ref": "#/components/schemas/CreateExternalEventType__schema0" }, "parametersSchema": { "$ref": "#/components/schemas/CreateExternalEventType__schema0" }, "example": { "type": "object" }, "type": { "type": "string", "enum": ["webhook"] }, "subscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "unsubscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "handle": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refresh": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } } } }, "CreateExternalEventType__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CreateExternalEventType__schema0" } }, "items": { "$ref": "#/components/schemas/CreateExternalEventType__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/CreateExternalEventType__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/CreateExternalEventType__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "CreateFieldMapping": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "fieldMappingId": { "type": "string" }, "universalFieldMappingId": { "type": "string" }, "dataSourceId": { "type": "string" }, "dataSourceUuid": { "type": "string" }, "appSchema": { "$ref": "#/components/schemas/CreateFieldMapping__schema0" }, "direction": { "type": "string", "enum": ["import", "export", "both"] }, "defaultImportValue": { "type": "object" }, "defaultExportValue": { "type": "object" }, "importValue": { "type": "object" }, "exportValue": { "type": "object" }, "unifiedImportValue": { "type": "object" }, "unifiedExportValue": { "type": "object" }, "frozenImportFields": { "type": "object" }, "frozenExportFields": { "type": "object" }, "frozenUnifiedExportFields": { "type": "object" } } }, "CreateFieldMapping__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CreateFieldMapping__schema0" } }, "items": { "$ref": "#/components/schemas/CreateFieldMapping__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/CreateFieldMapping__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/CreateFieldMapping__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "CreateFlow": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/CreateFlow__schema0" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/CreateFlow__schema1" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" } } }, "CreateFlow__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CreateFlow__schema0" } }, "items": { "$ref": "#/components/schemas/CreateFlow__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/CreateFlow__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/CreateFlow__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "CreateFlow__schema1": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/CreateFlow__schema1" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "CreateIntegrationDto": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "logoUri": { "type": "string" }, "externalAppId": { "description": "External app id; alternative to connectorId — resolves to the app's default connector.", "type": "string" }, "externalAppUuid": { "type": "string" }, "oAuthCallbackUri": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "string", "enum": [""] } ] }, "logoBase64": { "type": "string" }, "connectorVersion": { "type": "string" }, "connectorId": { "description": "ID of the connector this integration uses.", "type": "string" }, "connectorUuid": { "type": "string" }, "connectorKey": { "description": "Key of the connector; alternative to connectorId. Resolved to connectorId by the API.", "type": "string" }, "parameters": { "description": "Connector-specific parameters (e.g. OAuth { clientId, clientSecret, scopes }).", "type": "object", "additionalProperties": { "type": "object" } }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "intent": { "description": "[Experimental] Intent-based instruction for an agent to configure this element.", "type": "string" } } }, "CreatePackage": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } } } }, "CustomerApiResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "CustomersPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "DataCollectionCreateRequestDto": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "object" } }, "fields": { "type": "object", "additionalProperties": { "type": "object" } } }, "required": ["fields"] }, "DataCollectionCreateResponseDto": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, "DataCollectionDeleteRequestDto": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "object" } }, "id": { "type": "string" } }, "required": ["id"] }, "DataCollectionDeleteResponseDto": { "type": "object", "properties": {} }, "DataCollectionFindByIdRequestDto": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "object" } }, "id": { "type": "string" }, "udm": { "type": "string" } }, "required": ["id"] }, "DataCollectionFindByIdResponseDto": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "uri": { "type": "string" }, "iconUri": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "udm": { "type": "string" }, "unifiedFields": { "type": "object", "additionalProperties": { "type": "object" } }, "rawFields": { "type": "object", "additionalProperties": { "type": "object" } }, "createdTime": { "type": "string" }, "updatedTime": { "type": "string" }, "deletedTime": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" } }, "required": ["id"] } }, "required": ["record"] }, "DataCollectionListRequestDto": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "object" } }, "filter": { "type": "object" }, "unifiedFilter": { "type": "object" }, "cursor": { "type": "string" } } }, "DataCollectionListResponseDto": { "type": "object", "properties": { "records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "uri": { "type": "string" }, "iconUri": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "udm": { "type": "string" }, "unifiedFields": { "type": "object", "additionalProperties": { "type": "object" } }, "rawFields": { "type": "object", "additionalProperties": { "type": "object" } }, "createdTime": { "type": "string" }, "updatedTime": { "type": "string" }, "deletedTime": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" } }, "required": ["id"] } }, "drilldowns": { "type": "array", "items": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "object" } }, "filter": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "cursor": { "type": "string" } }, "required": ["records"] }, "DataCollectionMatchRequestDto": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } } }, "required": ["query"] }, "DataCollectionMatchResponseDto": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "uri": { "type": "string" }, "iconUri": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "udm": { "type": "string" }, "unifiedFields": { "type": "object", "additionalProperties": { "type": "object" } }, "rawFields": { "type": "object", "additionalProperties": { "type": "object" } }, "createdTime": { "type": "string" }, "updatedTime": { "type": "string" }, "deletedTime": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" } }, "required": ["id"] } } }, "DataCollectionSearchRequestDto": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "string" }, "cursor": { "type": "string" } }, "required": ["query"] }, "DataCollectionSearchResponseDto": { "type": "object", "properties": { "records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "uri": { "type": "string" }, "iconUri": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "udm": { "type": "string" }, "unifiedFields": { "type": "object", "additionalProperties": { "type": "object" } }, "rawFields": { "type": "object", "additionalProperties": { "type": "object" } }, "createdTime": { "type": "string" }, "updatedTime": { "type": "string" }, "deletedTime": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" } }, "required": ["id"] } }, "cursor": { "type": "string" } }, "required": ["records"] }, "DataCollectionSpecDto": { "type": "object", "properties": { "type": { "type": "string", "enum": ["collection"] }, "key": { "type": "string" }, "name": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/DataCollectionSpecDto__schema0" }, "fieldsSchema": { "$ref": "#/components/schemas/DataCollectionSpecDto__schema0" }, "list": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "filterFields": { "type": "array", "items": { "type": "string" } } } }, "search": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "match": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } } } }, "findById": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "create": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "requiredFields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "update": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "delete": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "events": { "type": "object", "properties": { "created": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "updated": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "deleted": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "all": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "additionalProperties": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "customFields": { "type": "boolean" }, "udm": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" } }, "extract": { "type": "object", "additionalProperties": { "type": "object" } }, "parse": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "find": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "queryFields": { "type": "array", "items": { "type": "string" } } } } }, "required": ["type", "name"] }, "DataCollectionSpecDto__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataCollectionSpecDto__schema0" } }, "items": { "$ref": "#/components/schemas/DataCollectionSpecDto__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/DataCollectionSpecDto__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/DataCollectionSpecDto__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "DataCollectionUpdateRequestDto": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "object" } }, "id": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } } }, "required": ["id", "fields"] }, "DataCollectionUpdateResponseDto": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, "DataLinkTableApiResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/DataLinkTableApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "dataLinkTableId": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "integrationId": { "type": "string" }, "isCustomized": { "type": "boolean" }, "user": { "type": "object" }, "connection": { "type": "object" }, "integration": { "type": "object" }, "dataLinkTable": { "type": "object" } }, "required": ["id", "name"] }, "DataLinkTableApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/DataLinkTableApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "DataLinkTableExportDto": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type." }, "key": { "type": "string", "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create." }, "name": { "type": "string", "description": "Display name. Optional on create; used to generate key when key is omitted." }, "description": { "type": "string", "description": "Optional human-readable description." }, "meta": { "type": "object", "description": "Optional key-value metadata.", "additionalProperties": { "type": "object" } }, "instanceKey": { "type": "string" } }, "required": ["uuid", "key"] }, "DataLinkTablesPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/DataLinkTablesPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "dataLinkTableId": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "integrationId": { "type": "string" }, "isCustomized": { "type": "boolean" }, "user": { "type": "object" }, "connection": { "type": "object" }, "integration": { "type": "object" }, "dataLinkTable": { "type": "object" } }, "required": ["id", "name"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "DataLinkTablesPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/DataLinkTablesPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "DataLinksPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "dataLinkTableInstanceId": { "type": "string" }, "externalRecordId": { "type": "string" }, "appRecordId": { "type": "string" }, "direction": { "type": "string", "enum": ["import", "export", "both"] } }, "required": ["id", "dataLinkTableInstanceId", "externalRecordId", "appRecordId", "direction"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "DataSourceApiResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "dataSourceId": { "type": "string" }, "universalDataSourceId": { "type": "string" }, "udm": { "type": "string" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "collectionKey": { "type": "string" }, "collectionParameters": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "dataSourceRevision": { "type": "string" }, "universalDataSourceRevision": { "type": "string" }, "defaultCollectionKey": { "type": "string" }, "defaultCollectionParameters": { "type": "object" }, "collectionSpec": { "type": "object", "properties": { "type": { "type": "string", "enum": ["collection"] }, "key": { "type": "string" }, "name": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" }, "fieldsSchema": { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" }, "list": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "filterFields": { "type": "array", "items": { "type": "string" } } } }, "search": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "match": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } } } }, "findById": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "create": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "requiredFields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "update": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "delete": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "events": { "type": "object", "properties": { "created": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "updated": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "deleted": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "all": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "additionalProperties": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "customFields": { "type": "boolean" }, "udm": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" } }, "extract": { "type": "object", "additionalProperties": { "type": "object" } }, "parse": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "find": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "queryFields": { "type": "array", "items": { "type": "string" } } } } }, "required": ["type", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/DataSourceApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "dataSourceId": { "type": "string" }, "universalDataSourceId": { "type": "string" }, "udm": { "type": "string" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "collectionKey": { "type": "string" }, "collectionParameters": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "dataSourceRevision": { "type": "string" }, "universalDataSourceRevision": { "type": "string" }, "defaultCollectionKey": { "type": "string" }, "defaultCollectionParameters": { "type": "object" }, "collectionSpec": { "type": "object", "properties": { "type": { "type": "string", "enum": ["collection"] }, "key": { "type": "string" }, "name": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" }, "fieldsSchema": { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" }, "list": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "filterFields": { "type": "array", "items": { "type": "string" } } } }, "search": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "match": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } } } }, "findById": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "create": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "requiredFields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "update": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "delete": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "events": { "type": "object", "properties": { "created": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "updated": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "deleted": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "all": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "additionalProperties": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "customFields": { "type": "boolean" }, "udm": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" } }, "extract": { "type": "object", "additionalProperties": { "type": "object" } }, "parse": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "find": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "queryFields": { "type": "array", "items": { "type": "string" } } } } }, "required": ["type", "name"] } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/DataSourceApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceApiResponse__schema0" } }, "requestError": { "$ref": "#/components/schemas/DataSourceApiResponse__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/DataSourceApiResponse__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "dataSource": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "dataSourceId": { "type": "string" }, "universalDataSourceId": { "type": "string" }, "udm": { "type": "string" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "collectionKey": { "type": "string" }, "collectionParameters": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "dataSourceRevision": { "type": "string" }, "universalDataSourceRevision": { "type": "string" }, "defaultCollectionKey": { "type": "string" }, "defaultCollectionParameters": { "type": "object" }, "collectionSpec": { "type": "object", "properties": { "type": { "type": "string", "enum": ["collection"] }, "key": { "type": "string" }, "name": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" }, "fieldsSchema": { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" }, "list": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "filterFields": { "type": "array", "items": { "type": "string" } } } }, "search": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "match": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } } } }, "findById": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "create": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "requiredFields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "update": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "delete": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "events": { "type": "object", "properties": { "created": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "updated": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "deleted": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "all": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "additionalProperties": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "customFields": { "type": "boolean" }, "udm": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" } }, "extract": { "type": "object", "additionalProperties": { "type": "object" } }, "parse": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "find": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "queryFields": { "type": "array", "items": { "type": "string" } } } } }, "required": ["type", "name"] } }, "required": ["id", "name"] }, "path": { "type": "string" }, "defaultPath": { "type": "string" } }, "required": ["id", "name"] }, "DataSourceApiResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/DataSourceApiResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "DataSourceApiResponse__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" } }, "items": { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceApiResponse__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "DataSourceExportProperties": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationUuid": { "type": "string" }, "parentUuid": { "type": "string" }, "externalAppUuid": { "type": "string" }, "isCustomized": { "type": "boolean" }, "isUniversal": { "type": "boolean" }, "instanceKey": { "type": "string" }, "udm": { "type": "string" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "collectionKey": { "type": "string" }, "collectionParameters": { "type": "object" }, "path": { "deprecated": true, "type": "string" }, "defaultPath": { "deprecated": true, "type": "string" } }, "required": ["uuid", "key"] }, "DataSourcePaginatedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "dataSourceId": { "type": "string" }, "universalDataSourceId": { "type": "string" }, "udm": { "type": "string" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "collectionKey": { "type": "string" }, "collectionParameters": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "dataSourceRevision": { "type": "string" }, "universalDataSourceRevision": { "type": "string" }, "defaultCollectionKey": { "type": "string" }, "defaultCollectionParameters": { "type": "object" }, "collectionSpec": { "type": "object", "properties": { "type": { "type": "string", "enum": ["collection"] }, "key": { "type": "string" }, "name": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" }, "fieldsSchema": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" }, "list": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "filterFields": { "type": "array", "items": { "type": "string" } } } }, "search": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "match": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } } } }, "findById": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "create": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "requiredFields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "update": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "delete": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "events": { "type": "object", "properties": { "created": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "updated": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "deleted": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "all": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "additionalProperties": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "customFields": { "type": "boolean" }, "udm": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" } }, "extract": { "type": "object", "additionalProperties": { "type": "object" } }, "parse": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "find": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "queryFields": { "type": "array", "items": { "type": "string" } } } } }, "required": ["type", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "dataSourceId": { "type": "string" }, "universalDataSourceId": { "type": "string" }, "udm": { "type": "string" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "collectionKey": { "type": "string" }, "collectionParameters": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "dataSourceRevision": { "type": "string" }, "universalDataSourceRevision": { "type": "string" }, "defaultCollectionKey": { "type": "string" }, "defaultCollectionParameters": { "type": "object" }, "collectionSpec": { "type": "object", "properties": { "type": { "type": "string", "enum": ["collection"] }, "key": { "type": "string" }, "name": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" }, "fieldsSchema": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" }, "list": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "filterFields": { "type": "array", "items": { "type": "string" } } } }, "search": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "match": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } } } }, "findById": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "create": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "requiredFields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "update": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "delete": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "events": { "type": "object", "properties": { "created": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "updated": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "deleted": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "all": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "additionalProperties": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "customFields": { "type": "boolean" }, "udm": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" } }, "extract": { "type": "object", "additionalProperties": { "type": "object" } }, "parse": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "find": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "queryFields": { "type": "array", "items": { "type": "string" } } } } }, "required": ["type", "name"] } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema0" } }, "requestError": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "dataSource": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "dataSourceId": { "type": "string" }, "universalDataSourceId": { "type": "string" }, "udm": { "type": "string" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "collectionKey": { "type": "string" }, "collectionParameters": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "dataSourceRevision": { "type": "string" }, "universalDataSourceRevision": { "type": "string" }, "defaultCollectionKey": { "type": "string" }, "defaultCollectionParameters": { "type": "object" }, "collectionSpec": { "type": "object", "properties": { "type": { "type": "string", "enum": ["collection"] }, "key": { "type": "string" }, "name": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" }, "fieldsSchema": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" }, "list": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "filterFields": { "type": "array", "items": { "type": "string" } } } }, "search": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "match": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } } } }, "findById": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "create": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "requiredFields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "update": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "fields": { "type": "array", "items": { "type": "string" } }, "excludedFields": { "type": "array", "items": { "type": "string" } } } }, "delete": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } } } }, "events": { "type": "object", "properties": { "created": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "updated": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "deleted": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] }, "all": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "additionalProperties": { "type": "object", "properties": { "type": { "type": "string", "enum": ["push", "pull"] }, "isFullScan": { "type": "boolean" }, "isIdOnly": { "type": "boolean" } }, "required": ["type"] } }, "customFields": { "type": "boolean" }, "udm": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" } }, "extract": { "type": "object", "additionalProperties": { "type": "object" } }, "parse": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "find": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "object" }, "method": { "type": "object" } }, "required": ["path", "method"] } }, "queryFields": { "type": "array", "items": { "type": "string" } } } } }, "required": ["type", "name"] } }, "required": ["id", "name"] }, "path": { "type": "string" }, "defaultPath": { "type": "string" } }, "required": ["id", "name"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "DataSourcePaginatedResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "DataSourcePaginatedResponse__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" } }, "items": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourcePaginatedResponse__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "DeleteDataLinkDto": { "type": "object", "properties": { "direction": { "type": "string", "enum": ["import", "export", "both"] }, "appRecordId": { "type": "string" }, "externalRecordId": { "type": "string" } }, "required": ["direction", "appRecordId", "externalRecordId"] }, "ElementLogsResponseDto": { "type": "array", "items": { "type": "object", "properties": {} } }, "EnsureConnectionDto": { "type": "object", "properties": { "appUrl": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "URL or domain of the app to connect to (e.g. \"https://slack.com\" or \"slack.com\"). Will be normalized to a domain." }, "name": { "type": "string", "description": "Custom name for the connection. Only used when a new connection is created; ignored if an existing one is returned." } }, "required": ["appUrl"] }, "ExternalAppDto": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "isReadOnly": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isConnected": { "type": "boolean" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "appUri": { "type": "string", "format": "uri" }, "logoUri": { "type": "string", "format": "uri" }, "defaultConnectorId": { "type": "string" }, "basePackageId": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "popularity": { "type": "number" }, "readmeSlug": { "type": "string" }, "hasAuth": { "type": "boolean" }, "hasData": { "type": "boolean" }, "hasFreeTestAccount": { "type": "boolean", "nullable": true }, "freeTestAccountGuide": { "type": "string" }, "freeTestAccountGuideVerifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "nullable": true }, "openapiSpecs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "sourceUri": { "type": "string" } } } }, "tenantId": { "type": "string" } }, "required": [ "id", "key", "isReadOnly", "uuid", "name", "appUri", "logoUri", "defaultConnectorId", "categories", "popularity" ] }, "ExternalAppsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "isReadOnly": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isConnected": { "type": "boolean" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "appUri": { "type": "string", "format": "uri" }, "logoUri": { "type": "string", "format": "uri" }, "defaultConnectorId": { "type": "string" }, "basePackageId": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "popularity": { "type": "number" }, "readmeSlug": { "type": "string" }, "hasAuth": { "type": "boolean" }, "hasData": { "type": "boolean" }, "hasFreeTestAccount": { "type": "boolean", "nullable": true }, "freeTestAccountGuide": { "type": "string" }, "freeTestAccountGuideVerifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "nullable": true }, "openapiSpecs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "sourceUri": { "type": "string" } } } }, "tenantId": { "type": "string" } }, "required": [ "id", "key", "isReadOnly", "uuid", "name", "appUri", "logoUri", "defaultConnectorId", "categories", "popularity" ] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ExternalAppsPaginatedV2ResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "isReadOnly": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "appUri": { "type": "string", "format": "uri" }, "logoUri": { "type": "string", "format": "uri" }, "defaultConnectorId": { "type": "string" }, "basePackageId": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "popularity": { "type": "number" }, "readmeSlug": { "type": "string" }, "hasAuth": { "type": "boolean" }, "hasData": { "type": "boolean" }, "hasFreeTestAccount": { "type": "boolean", "nullable": true }, "freeTestAccountGuide": { "type": "string" }, "freeTestAccountGuideVerifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "nullable": true }, "openapiSpecs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "sourceUri": { "type": "string" } } } } }, "required": [ "id", "key", "isReadOnly", "uuid", "name", "appUri", "logoUri", "defaultConnectorId", "categories", "popularity" ] } }, "cursor": { "type": "string" }, "total": { "type": "number" } }, "required": ["items", "total"] }, "ExternalEventLogRecordApiResponseDto": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "externalEventSubscriptionId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "payload": { "type": "object" }, "launchedFlowRunIds": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["created", "error", "success"] }, "error": { "$ref": "#/components/schemas/ExternalEventLogRecordApiResponseDto__schema0" }, "flowTriggerSkipReason": { "type": "object", "properties": { "code": { "type": "string", "enum": ["all-dependent-flow-instances-disabled"] }, "message": { "type": "string" }, "dependentFlowInstanceIds": { "type": "array", "items": { "type": "string" } } }, "required": ["code", "message", "dependentFlowInstanceIds"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "externalEventSubscription": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "connectionId": { "type": "string" }, "integrationId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string", "enum": ["data-record-created", "data-record-updated", "data-record-deleted", "connector-event"] }, "dataSource": { "type": "object", "properties": { "key": { "type": "object" }, "collectionKey": { "type": "object" }, "collectionParameters": { "type": "object" }, "udm": { "type": "object" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "path": { "type": "object" }, "defaultPath": { "type": "object" } } }, "eventKey": { "type": "string" }, "eventParameters": { "type": "object" } }, "required": ["type"] }, "status": { "type": "string", "enum": ["subscribed", "unsubscribed", "error"] }, "error": { "$ref": "#/components/schemas/ExternalEventLogRecordApiResponseDto__schema0" }, "isRealTime": { "type": "boolean" }, "requiresPull": { "type": "boolean" }, "requiresFullSync": { "type": "boolean" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "stateData": { "type": "object" }, "nextPullEventsTimestamp": { "type": "number" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "nextRefreshTimestamp": { "type": "number" }, "globalWebhookKey": { "type": "string" }, "globalWebhookEventSelector": { "type": "string" }, "incomingWebhookUri": { "type": "string" }, "webhookUri": { "type": "string" } }, "required": ["userId", "id", "connectionId", "integrationId"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventLogRecordApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventLogRecordApiResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ExternalEventLogRecordApiResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ExternalEventLogRecordApiResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] } }, "required": ["userId", "id", "integrationId", "connectionId", "externalEventSubscriptionId", "status"] }, "ExternalEventLogRecordApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ExternalEventLogRecordApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ExternalEventLogRecordInDb": { "type": "object", "properties": {} }, "ExternalEventLogRecordsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "externalEventSubscriptionId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "payload": { "type": "object" }, "launchedFlowRunIds": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["created", "error", "success"] }, "error": { "$ref": "#/components/schemas/ExternalEventLogRecordsPaginatedResponseDto__schema0" }, "flowTriggerSkipReason": { "type": "object", "properties": { "code": { "type": "string", "enum": ["all-dependent-flow-instances-disabled"] }, "message": { "type": "string" }, "dependentFlowInstanceIds": { "type": "array", "items": { "type": "string" } } }, "required": ["code", "message", "dependentFlowInstanceIds"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "externalEventSubscription": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "connectionId": { "type": "string" }, "integrationId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "data-record-created", "data-record-updated", "data-record-deleted", "connector-event" ] }, "dataSource": { "type": "object", "properties": { "key": { "type": "object" }, "collectionKey": { "type": "object" }, "collectionParameters": { "type": "object" }, "udm": { "type": "object" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "path": { "type": "object" }, "defaultPath": { "type": "object" } } }, "eventKey": { "type": "string" }, "eventParameters": { "type": "object" } }, "required": ["type"] }, "status": { "type": "string", "enum": ["subscribed", "unsubscribed", "error"] }, "error": { "$ref": "#/components/schemas/ExternalEventLogRecordsPaginatedResponseDto__schema0" }, "isRealTime": { "type": "boolean" }, "requiresPull": { "type": "boolean" }, "requiresFullSync": { "type": "boolean" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "stateData": { "type": "object" }, "nextPullEventsTimestamp": { "type": "number" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "nextRefreshTimestamp": { "type": "number" }, "globalWebhookKey": { "type": "string" }, "globalWebhookEventSelector": { "type": "string" }, "incomingWebhookUri": { "type": "string" }, "webhookUri": { "type": "string" } }, "required": ["userId", "id", "connectionId", "integrationId"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventLogRecordsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventLogRecordsPaginatedResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ExternalEventLogRecordsPaginatedResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ExternalEventLogRecordsPaginatedResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] } }, "required": ["userId", "id", "integrationId", "connectionId", "externalEventSubscriptionId", "status"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ExternalEventLogRecordsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ExternalEventLogRecordsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ExternalEventPullApiResponseDto": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "externalEventSubscriptionId": { "type": "string" }, "startDatetime": { "type": "string" }, "endDatetime": { "type": "string" }, "isFullScan": { "type": "boolean" }, "status": { "type": "string", "enum": ["running", "success", "error", "queued"] }, "collectedEventIds": { "type": "array", "items": { "type": "string" } }, "telemetryUri": { "description": "Storage key of the per-pull diagnostic telemetry artifact (what this pull observed and why it did or did not emit events). Read via GET /external-event-pulls/{id}/telemetry.", "type": "string" }, "error": { "$ref": "#/components/schemas/ExternalEventPullApiResponseDto__schema0" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "externalEventSubscription": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "connectionId": { "type": "string" }, "integrationId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string", "enum": ["data-record-created", "data-record-updated", "data-record-deleted", "connector-event"] }, "dataSource": { "type": "object", "properties": { "key": { "type": "object" }, "collectionKey": { "type": "object" }, "collectionParameters": { "type": "object" }, "udm": { "type": "object" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "path": { "type": "object" }, "defaultPath": { "type": "object" } } }, "eventKey": { "type": "string" }, "eventParameters": { "type": "object" } }, "required": ["type"] }, "status": { "type": "string", "enum": ["subscribed", "unsubscribed", "error"] }, "error": { "$ref": "#/components/schemas/ExternalEventPullApiResponseDto__schema0" }, "isRealTime": { "type": "boolean" }, "requiresPull": { "type": "boolean" }, "requiresFullSync": { "type": "boolean" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "stateData": { "type": "object" }, "nextPullEventsTimestamp": { "type": "number" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "nextRefreshTimestamp": { "type": "number" }, "globalWebhookKey": { "type": "string" }, "globalWebhookEventSelector": { "type": "string" }, "incomingWebhookUri": { "type": "string" }, "webhookUri": { "type": "string" } }, "required": ["userId", "id", "connectionId", "integrationId"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventPullApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventPullApiResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ExternalEventPullApiResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ExternalEventPullApiResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] } }, "required": [ "userId", "id", "integrationId", "connectionId", "externalEventSubscriptionId", "startDatetime", "endDatetime", "status", "collectedEventIds" ] }, "ExternalEventPullApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ExternalEventPullApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ExternalEventPullTelemetryDto": { "type": "object", "properties": { "pullId": { "type": "string" }, "subscriptionId": { "type": "string" }, "connectionId": { "type": "string" }, "strategy": { "type": "string", "enum": ["full-scan", "pull-latest-records", "custom-pull", "skipped", "unknown"] }, "eventType": { "type": "string" }, "collectionKey": { "type": "string" }, "startedAt": { "type": "string" }, "finishedAt": { "type": "string" }, "emittedEventCount": { "type": "number" }, "emittedEvents": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "recordId": { "type": "string" } }, "required": ["type"] } }, "notes": { "type": "array", "items": { "type": "string" } }, "fullScan": { "type": "object", "properties": { "totalRecords": { "type": "number" }, "totalPages": { "type": "number" }, "previousSnapshotId": { "type": "string" }, "previousSnapshotRecordCount": { "type": "number" }, "previousSnapshotMissing": { "type": "boolean" }, "newSnapshotId": { "type": "string" }, "isBaseline": { "type": "boolean" } }, "required": ["totalRecords", "totalPages", "previousSnapshotMissing", "isBaseline"] }, "pullLatest": { "type": "object", "properties": { "stateBefore": { "type": "object", "properties": { "id": { "type": "string" }, "datetime": { "type": "string" } } }, "stateAfter": { "type": "object", "properties": { "id": { "type": "string" }, "datetime": { "type": "string" } } }, "pagesScanned": { "type": "number" }, "scannedRecords": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "datetime": { "type": "string" } }, "required": ["id"] } }, "newRecordIds": { "type": "array", "items": { "type": "string" } }, "isBaseline": { "type": "boolean" } }, "required": ["pagesScanned", "scannedRecords", "newRecordIds", "isBaseline"] } }, "required": [ "pullId", "subscriptionId", "strategy", "startedAt", "finishedAt", "emittedEventCount", "emittedEvents", "notes" ] }, "ExternalEventPullsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "externalEventSubscriptionId": { "type": "string" }, "startDatetime": { "type": "string" }, "endDatetime": { "type": "string" }, "isFullScan": { "type": "boolean" }, "status": { "type": "string", "enum": ["running", "success", "error", "queued"] }, "collectedEventIds": { "type": "array", "items": { "type": "string" } }, "telemetryUri": { "description": "Storage key of the per-pull diagnostic telemetry artifact (what this pull observed and why it did or did not emit events). Read via GET /external-event-pulls/{id}/telemetry.", "type": "string" }, "error": { "$ref": "#/components/schemas/ExternalEventPullsPaginatedResponseDto__schema0" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "externalEventSubscription": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "connectionId": { "type": "string" }, "integrationId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "data-record-created", "data-record-updated", "data-record-deleted", "connector-event" ] }, "dataSource": { "type": "object", "properties": { "key": { "type": "object" }, "collectionKey": { "type": "object" }, "collectionParameters": { "type": "object" }, "udm": { "type": "object" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "path": { "type": "object" }, "defaultPath": { "type": "object" } } }, "eventKey": { "type": "string" }, "eventParameters": { "type": "object" } }, "required": ["type"] }, "status": { "type": "string", "enum": ["subscribed", "unsubscribed", "error"] }, "error": { "$ref": "#/components/schemas/ExternalEventPullsPaginatedResponseDto__schema0" }, "isRealTime": { "type": "boolean" }, "requiresPull": { "type": "boolean" }, "requiresFullSync": { "type": "boolean" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "stateData": { "type": "object" }, "nextPullEventsTimestamp": { "type": "number" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "nextRefreshTimestamp": { "type": "number" }, "globalWebhookKey": { "type": "string" }, "globalWebhookEventSelector": { "type": "string" }, "incomingWebhookUri": { "type": "string" }, "webhookUri": { "type": "string" } }, "required": ["userId", "id", "connectionId", "integrationId"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventPullsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventPullsPaginatedResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ExternalEventPullsPaginatedResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ExternalEventPullsPaginatedResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] } }, "required": [ "userId", "id", "integrationId", "connectionId", "externalEventSubscriptionId", "startDatetime", "endDatetime", "status", "collectedEventIds" ] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ExternalEventPullsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ExternalEventPullsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ExternalEventSubscriptionApiResponseDto": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "connectionId": { "type": "string" }, "integrationId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string", "enum": ["data-record-created", "data-record-updated", "data-record-deleted", "connector-event"] }, "dataSource": { "type": "object", "properties": { "key": { "type": "object" }, "collectionKey": { "type": "object" }, "collectionParameters": { "type": "object" }, "udm": { "type": "object" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "path": { "type": "object" }, "defaultPath": { "type": "object" } } }, "eventKey": { "type": "string" }, "eventParameters": { "type": "object" } }, "required": ["type"] }, "status": { "type": "string", "enum": ["subscribed", "unsubscribed", "error"] }, "error": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto__schema0" }, "isRealTime": { "type": "boolean" }, "requiresPull": { "type": "boolean" }, "requiresFullSync": { "type": "boolean" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "stateData": { "type": "object" }, "nextPullEventsTimestamp": { "type": "number" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "nextRefreshTimestamp": { "type": "number" }, "globalWebhookKey": { "type": "string" }, "globalWebhookEventSelector": { "type": "string" }, "incomingWebhookUri": { "type": "string" }, "webhookUri": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["userId", "id", "connectionId", "integrationId"] }, "ExternalEventSubscriptionApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ExternalEventSubscriptionApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ExternalEventSubscriptionsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "connectionId": { "type": "string" }, "integrationId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string", "enum": ["data-record-created", "data-record-updated", "data-record-deleted", "connector-event"] }, "dataSource": { "type": "object", "properties": { "key": { "type": "object" }, "collectionKey": { "type": "object" }, "collectionParameters": { "type": "object" }, "udm": { "type": "object" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "path": { "type": "object" }, "defaultPath": { "type": "object" } } }, "eventKey": { "type": "string" }, "eventParameters": { "type": "object" } }, "required": ["type"] }, "status": { "type": "string", "enum": ["subscribed", "unsubscribed", "error"] }, "error": { "$ref": "#/components/schemas/ExternalEventSubscriptionsPaginatedResponseDto__schema0" }, "isRealTime": { "type": "boolean" }, "requiresPull": { "type": "boolean" }, "requiresFullSync": { "type": "boolean" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "stateData": { "type": "object" }, "nextPullEventsTimestamp": { "type": "number" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "nextRefreshTimestamp": { "type": "number" }, "globalWebhookKey": { "type": "string" }, "globalWebhookEventSelector": { "type": "string" }, "incomingWebhookUri": { "type": "string" }, "webhookUri": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventSubscriptionsPaginatedResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/ExternalEventSubscriptionsPaginatedResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/ExternalEventSubscriptionsPaginatedResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventSubscriptionsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["userId", "id", "connectionId", "integrationId"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ExternalEventSubscriptionsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ExternalEventSubscriptionsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ExternalEventTypeApiResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "isCustomized": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema1" }, "parametersSchema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema1" }, "example": { "type": "object" }, "type": { "type": "string", "enum": ["webhook"] }, "subscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "unsubscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "handle": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refresh": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "isCustomized": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema1" }, "parametersSchema": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema1" }, "example": { "type": "object" }, "type": { "type": "string", "enum": ["webhook"] }, "subscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "unsubscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "handle": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "refresh": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } } }, "required": ["id", "name"] }, "ExternalEventTypeApiResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ExternalEventTypeApiResponse__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema1" } }, "items": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventTypeApiResponse__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ExternalEventTypeExportProperties": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationUuid": { "type": "string" }, "parentUuid": { "type": "string" }, "externalAppUuid": { "type": "string" }, "isCustomized": { "type": "boolean" }, "isUniversal": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/ExternalEventTypeExportProperties__schema0" }, "parametersSchema": { "$ref": "#/components/schemas/ExternalEventTypeExportProperties__schema0" }, "example": { "type": "object" }, "type": { "type": "string", "enum": ["webhook"] }, "subscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "unsubscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "handle": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refresh": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } } }, "required": ["uuid", "key"] }, "ExternalEventTypeExportProperties__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ExternalEventTypeExportProperties__schema0" } }, "items": { "$ref": "#/components/schemas/ExternalEventTypeExportProperties__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ExternalEventTypeExportProperties__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventTypeExportProperties__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ExternalEventTypePaginatedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "isCustomized": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema1" }, "parametersSchema": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema1" }, "example": { "type": "object" }, "type": { "type": "string", "enum": ["webhook"] }, "subscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "unsubscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "handle": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refresh": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "isCustomized": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema1" }, "parametersSchema": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema1" }, "example": { "type": "object" }, "type": { "type": "string", "enum": ["webhook"] }, "subscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "unsubscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "handle": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "refresh": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } } }, "required": ["id", "name"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ExternalEventTypePaginatedResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "ExternalEventTypePaginatedResponse__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema1" } }, "items": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEventTypePaginatedResponse__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ExternalLogDetailsDto": { "type": "object", "properties": { "request": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Request details" }, "response": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Response data" }, "status": { "type": "number", "description": "HTTP status code" } }, "required": ["data", "status"], "description": "Response details" }, "timeMs": { "type": "number", "description": "Response time in milliseconds" } }, "required": ["request", "response", "timeMs"] }, "FieldMappingApiResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "fieldMappingId": { "type": "string" }, "universalFieldMappingId": { "type": "string" }, "dataSourceId": { "type": "string" }, "dataSourceUuid": { "type": "string" }, "appSchema": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" }, "direction": { "type": "string", "enum": ["import", "export", "both"] }, "defaultImportValue": { "type": "object" }, "defaultExportValue": { "type": "object" }, "importValue": { "type": "object" }, "exportValue": { "type": "object" }, "unifiedImportValue": { "type": "object" }, "unifiedExportValue": { "type": "object" }, "frozenImportFields": { "type": "object" }, "frozenExportFields": { "type": "object" }, "frozenUnifiedExportFields": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "fieldMappingRevision": { "type": "string" }, "universalFieldMappingRevision": { "type": "string" }, "dataSourceInstanceId": { "type": "string" }, "dataSourceSchema": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" }, "error": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "fieldMappingId": { "type": "string" }, "universalFieldMappingId": { "type": "string" }, "dataSourceId": { "type": "string" }, "dataSourceUuid": { "type": "string" }, "appSchema": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" }, "direction": { "type": "string", "enum": ["import", "export", "both"] }, "defaultImportValue": { "type": "object" }, "defaultExportValue": { "type": "object" }, "importValue": { "type": "object" }, "exportValue": { "type": "object" }, "unifiedImportValue": { "type": "object" }, "unifiedExportValue": { "type": "object" }, "frozenImportFields": { "type": "object" }, "frozenExportFields": { "type": "object" }, "frozenUnifiedExportFields": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "fieldMappingRevision": { "type": "string" }, "universalFieldMappingRevision": { "type": "string" }, "dataSourceInstanceId": { "type": "string" }, "dataSourceSchema": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" }, "error": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" } }, "requestError": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/FieldMappingApiResponse__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "fieldMapping": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "fieldMappingId": { "type": "string" }, "universalFieldMappingId": { "type": "string" }, "dataSourceId": { "type": "string" }, "dataSourceUuid": { "type": "string" }, "appSchema": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" }, "direction": { "type": "string", "enum": ["import", "export", "both"] }, "defaultImportValue": { "type": "object" }, "defaultExportValue": { "type": "object" }, "importValue": { "type": "object" }, "exportValue": { "type": "object" }, "unifiedImportValue": { "type": "object" }, "unifiedExportValue": { "type": "object" }, "frozenImportFields": { "type": "object" }, "frozenExportFields": { "type": "object" }, "frozenUnifiedExportFields": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "fieldMappingRevision": { "type": "string" }, "universalFieldMappingRevision": { "type": "string" }, "dataSourceInstanceId": { "type": "string" }, "dataSourceSchema": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" }, "error": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" } }, "required": ["id", "name"] } }, "required": ["id", "name"] }, "FieldMappingApiResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FieldMappingApiResponse__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" } }, "items": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiResponse__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "FieldMappingAppSchemaResponseDto": { "type": "object", "properties": {} }, "FieldMappingExportProperties": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationUuid": { "type": "string" }, "parentUuid": { "type": "string" }, "externalAppUuid": { "type": "string" }, "isCustomized": { "type": "boolean" }, "isUniversal": { "type": "boolean" }, "instanceKey": { "type": "string" }, "dataSourceUuid": { "type": "string" }, "appSchema": { "$ref": "#/components/schemas/FieldMappingExportProperties__schema0" }, "direction": { "type": "string", "enum": ["import", "export", "both"] }, "defaultImportValue": { "type": "object" }, "defaultExportValue": { "type": "object" }, "importValue": { "type": "object" }, "exportValue": { "type": "object" }, "unifiedImportValue": { "type": "object" }, "unifiedExportValue": { "type": "object" }, "frozenImportFields": { "type": "object" }, "frozenExportFields": { "type": "object" }, "frozenUnifiedExportFields": { "type": "object" } }, "required": ["uuid", "key"] }, "FieldMappingExportProperties__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldMappingExportProperties__schema0" } }, "items": { "$ref": "#/components/schemas/FieldMappingExportProperties__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/FieldMappingExportProperties__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingExportProperties__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "FieldMappingPaginatedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "fieldMappingId": { "type": "string" }, "universalFieldMappingId": { "type": "string" }, "dataSourceId": { "type": "string" }, "dataSourceUuid": { "type": "string" }, "appSchema": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" }, "direction": { "type": "string", "enum": ["import", "export", "both"] }, "defaultImportValue": { "type": "object" }, "defaultExportValue": { "type": "object" }, "importValue": { "type": "object" }, "exportValue": { "type": "object" }, "unifiedImportValue": { "type": "object" }, "unifiedExportValue": { "type": "object" }, "frozenImportFields": { "type": "object" }, "frozenExportFields": { "type": "object" }, "frozenUnifiedExportFields": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "fieldMappingRevision": { "type": "string" }, "universalFieldMappingRevision": { "type": "string" }, "dataSourceInstanceId": { "type": "string" }, "dataSourceSchema": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" }, "error": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "fieldMappingId": { "type": "string" }, "universalFieldMappingId": { "type": "string" }, "dataSourceId": { "type": "string" }, "dataSourceUuid": { "type": "string" }, "appSchema": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" }, "direction": { "type": "string", "enum": ["import", "export", "both"] }, "defaultImportValue": { "type": "object" }, "defaultExportValue": { "type": "object" }, "importValue": { "type": "object" }, "exportValue": { "type": "object" }, "unifiedImportValue": { "type": "object" }, "unifiedExportValue": { "type": "object" }, "frozenImportFields": { "type": "object" }, "frozenExportFields": { "type": "object" }, "frozenUnifiedExportFields": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "fieldMappingRevision": { "type": "string" }, "universalFieldMappingRevision": { "type": "string" }, "dataSourceInstanceId": { "type": "string" }, "dataSourceSchema": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" }, "error": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" } }, "requestError": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "fieldMapping": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "fieldMappingId": { "type": "string" }, "universalFieldMappingId": { "type": "string" }, "dataSourceId": { "type": "string" }, "dataSourceUuid": { "type": "string" }, "appSchema": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" }, "direction": { "type": "string", "enum": ["import", "export", "both"] }, "defaultImportValue": { "type": "object" }, "defaultExportValue": { "type": "object" }, "importValue": { "type": "object" }, "exportValue": { "type": "object" }, "unifiedImportValue": { "type": "object" }, "unifiedExportValue": { "type": "object" }, "frozenImportFields": { "type": "object" }, "frozenExportFields": { "type": "object" }, "frozenUnifiedExportFields": { "type": "object" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "fieldMappingRevision": { "type": "string" }, "universalFieldMappingRevision": { "type": "string" }, "dataSourceInstanceId": { "type": "string" }, "dataSourceSchema": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" }, "error": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" } }, "required": ["id", "name"] } }, "required": ["id", "name"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "FieldMappingPaginatedResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FieldMappingPaginatedResponse__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" } }, "items": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingPaginatedResponse__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "FileUploadResponseDto": { "type": "object", "properties": { "downloadUri": { "type": "string" } }, "required": ["downloadUri"] }, "FlowApiResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowApiResponse__schema1" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema0" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "flowRevision": { "type": "string" }, "universalFlowRevision": { "type": "string" }, "customized": { "type": "object", "properties": { "name": { "type": "boolean" }, "nodes": { "type": "boolean" } } }, "dependencies": { "type": "array", "items": { "type": "object" } }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowApiResponse__schema1" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema0" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "flowRevision": { "type": "string" }, "universalFlowRevision": { "type": "string" }, "customized": { "type": "object", "properties": { "name": { "type": "boolean" }, "nodes": { "type": "boolean" } } }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema0" } }, "requestError": { "$ref": "#/components/schemas/FlowApiResponse__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/FlowApiResponse__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "flow": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowApiResponse__schema1" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema0" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "flowRevision": { "type": "string" }, "universalFlowRevision": { "type": "string" }, "customized": { "type": "object", "properties": { "name": { "type": "boolean" }, "nodes": { "type": "boolean" } } }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] } }, "required": ["id", "name"] }, "FlowApiResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FlowApiResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FlowApiResponse__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FlowApiResponse__schema1" } }, "items": { "$ref": "#/components/schemas/FlowApiResponse__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/FlowApiResponse__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/FlowApiResponse__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "FlowExportProperties": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationUuid": { "type": "string" }, "parentUuid": { "type": "string" }, "externalAppUuid": { "type": "string" }, "isCustomized": { "type": "boolean" }, "isUniversal": { "type": "boolean" }, "instanceKey": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowExportProperties__schema0" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowExportProperties__schema1" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" } }, "required": ["uuid", "key"] }, "FlowExportProperties__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FlowExportProperties__schema0" } }, "items": { "$ref": "#/components/schemas/FlowExportProperties__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/FlowExportProperties__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/FlowExportProperties__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "FlowExportProperties__schema1": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FlowExportProperties__schema1" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FlowNodeRunOutputDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "cursor": { "type": "string" } }, "required": ["items"] }, "FlowNodeRunOutputResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "nodeKey": { "type": "string" }, "outputId": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "object" } }, "metadata": { "type": "object", "properties": { "timestamp": { "type": "string" }, "size": { "type": "number" } }, "required": ["timestamp", "size"] } }, "required": ["id", "nodeKey", "outputId", "data", "metadata"] }, "FlowNodeRunRecordWithoutOutputsDataDto": { "type": "object", "properties": { "id": { "type": "string" }, "upstreamRuns": { "type": "array", "items": { "type": "object", "properties": { "nodeKey": { "type": "string" }, "runId": { "type": "string" }, "outputId": { "type": "string" } }, "required": ["nodeKey", "runId", "outputId"] } }, "input": { "type": "object" }, "status": { "type": "string", "enum": ["completed", "failed", "skipped"] }, "logs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "downstreamRuns": { "type": "array", "items": { "type": "object", "properties": { "runId": { "type": "string" }, "nodeKey": { "type": "string" } }, "required": ["runId", "nodeKey"] } } }, "required": ["id", "downstreamRuns"] } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowNodeRunRecordWithoutOutputsDataDto__schema0" } } }, "required": ["id", "upstreamRuns", "input", "status", "logs", "outputs", "errors"] }, "FlowNodeRunRecordWithoutOutputsDataDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FlowNodeRunRecordWithoutOutputsDataDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FlowNodeRunsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "upstreamRuns": { "type": "array", "items": { "type": "object", "properties": { "nodeKey": { "type": "string" }, "runId": { "type": "string" }, "outputId": { "type": "string" } }, "required": ["nodeKey", "runId", "outputId"] } }, "input": { "type": "object" }, "status": { "type": "string", "enum": ["completed", "failed", "skipped"] }, "logs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "downstreamRuns": { "type": "array", "items": { "type": "object", "properties": { "runId": { "type": "string" }, "nodeKey": { "type": "string" } }, "required": ["runId", "nodeKey"] } } }, "required": ["id", "downstreamRuns"] } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowNodeRunsDto__schema0" } } }, "required": ["id", "upstreamRuns", "input", "status", "logs", "outputs", "errors"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "FlowNodeRunsDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FlowNodeRunsDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FlowPaginatedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema1" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "flowRevision": { "type": "string" }, "universalFlowRevision": { "type": "string" }, "customized": { "type": "object", "properties": { "name": { "type": "boolean" }, "nodes": { "type": "boolean" } } }, "dependencies": { "type": "array", "items": { "type": "object" } }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema1" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "flowRevision": { "type": "string" }, "universalFlowRevision": { "type": "string" }, "customized": { "type": "object", "properties": { "name": { "type": "boolean" }, "nodes": { "type": "boolean" } } }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" } }, "requestError": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/FlowPaginatedResponse__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "flow": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema1" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "flowRevision": { "type": "string" }, "universalFlowRevision": { "type": "string" }, "customized": { "type": "object", "properties": { "name": { "type": "boolean" }, "nodes": { "type": "boolean" } } }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] } }, "required": ["id", "name"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "FlowPaginatedResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FlowPaginatedResponse__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema1" } }, "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/FlowPaginatedResponse__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/FlowPaginatedResponse__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "FlowRunApiResponseDto": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "connectionFlowId": { "type": "string" }, "integrationFlowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "startNodeKey": { "type": "string" }, "input": { "type": "object" }, "state": { "type": "string", "enum": ["queued", "running", "completed", "stopped", "failed"] }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema0" } }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "state": { "type": "string", "enum": ["running", "completed", "stopped", "failed"] }, "runs": { "type": "number" }, "erroredRuns": { "type": "number" }, "outputs": { "type": "number" } }, "required": ["state"] } }, "launchedBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "api-trigger", "schedule-trigger", "app-event-trigger", "data-source-trigger", "external-event" ] }, "ids": { "type": "array", "items": { "type": "string" } } }, "required": ["type"] }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "flowInstance": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema1" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema0" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "flowRevision": { "type": "string" }, "universalFlowRevision": { "type": "string" }, "customized": { "type": "object", "properties": { "name": { "type": "boolean" }, "nodes": { "type": "boolean" } } }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/FlowRunApiResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] } }, "required": ["userId", "id", "connectionFlowId", "startNodeKey", "state", "startTime"] }, "FlowRunApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FlowRunApiResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunApiResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "FlowRunDto": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "connectionFlowId": { "type": "string" }, "integrationFlowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "startNodeKey": { "type": "string" }, "input": { "type": "object" }, "state": { "type": "string", "enum": ["queued", "running", "completed", "stopped", "failed"] }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunDto__schema0" } }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "state": { "type": "string", "enum": ["running", "completed", "stopped", "failed"] }, "runs": { "type": "number" }, "erroredRuns": { "type": "number" }, "outputs": { "type": "number" } }, "required": ["state"] } }, "launchedBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "api-trigger", "schedule-trigger", "app-event-trigger", "data-source-trigger", "external-event" ] }, "ids": { "type": "array", "items": { "type": "string" } } }, "required": ["type"] }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "flowInstance": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowRunDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowRunDto__schema1" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunDto__schema0" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "flowRevision": { "type": "string" }, "universalFlowRevision": { "type": "string" }, "customized": { "type": "object", "properties": { "name": { "type": "boolean" }, "nodes": { "type": "boolean" } } }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/FlowRunDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/FlowRunDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowRunDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] } }, "required": ["userId", "id", "connectionFlowId", "startNodeKey", "state", "startTime"] }, "FlowRunDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FlowRunDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FlowRunDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FlowRunDto__schema1" } }, "items": { "$ref": "#/components/schemas/FlowRunDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/FlowRunDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "FlowRunOutputDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "cursor": { "type": "string" } }, "required": ["items"] }, "FlowRunsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "connectionFlowId": { "type": "string" }, "integrationFlowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "startNodeKey": { "type": "string" }, "input": { "type": "object" }, "state": { "type": "string", "enum": ["queued", "running", "completed", "stopped", "failed"] }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema0" } }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "state": { "type": "string", "enum": ["running", "completed", "stopped", "failed"] }, "runs": { "type": "number" }, "erroredRuns": { "type": "number" }, "outputs": { "type": "number" } }, "required": ["state"] } }, "launchedBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "api-trigger", "schedule-trigger", "app-event-trigger", "data-source-trigger", "external-event" ] }, "ids": { "type": "array", "items": { "type": "string" } } }, "required": ["type"] }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "flowInstance": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema1" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema0" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "flowRevision": { "type": "string" }, "universalFlowRevision": { "type": "string" }, "customized": { "type": "object", "properties": { "name": { "type": "boolean" }, "nodes": { "type": "boolean" } } }, "dependencies": { "type": "array", "items": { "type": "object" } } }, "required": ["id", "name"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] } }, "required": ["userId", "id", "connectionFlowId", "startNodeKey", "state", "startTime"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "FlowRunsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "FlowRunsPaginatedResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/FlowRunsPaginatedResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "GenerateAccessTokenRequestDto": { "type": "object", "properties": { "isAdmin": { "type": "boolean", "description": "Whether to generate an admin token" }, "tenantId": { "type": "string", "description": "Customer ID to scope the token to" }, "tenantKey": { "type": "string", "description": "Customer key to scope the token to (resolved to tenantId)" }, "name": { "type": "string", "description": "Name for the generated token" }, "fields": { "type": "object", "description": "Custom fields to include in the token", "additionalProperties": { "type": "object" } } } }, "GenerateAccessTokenResponseDto": { "type": "object", "properties": { "token": { "type": "string", "description": "The generated access token" } }, "required": ["token"] }, "ImportConnectorDto": { "type": "object", "properties": { "uri": { "type": "string" } }, "required": ["uri"] }, "IncomingWebhookDetailsResponseDto": { "type": "object", "properties": { "request": { "type": "object", "properties": { "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "object", "additionalProperties": { "type": "object" } }, "query": { "type": "object", "additionalProperties": { "type": "object" } } }, "required": ["headers", "body", "query"] }, "response": { "type": "object", "properties": { "status": { "type": "number" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "data": { "type": "object", "additionalProperties": { "type": "object" } } }, "required": ["status", "headers", "data"] }, "events": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "error": { "type": "object", "additionalProperties": { "type": "object" } } }, "required": ["request", "response", "events"] }, "IncomingWebhookDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "workspaceId": { "type": "string" }, "customerId": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "subscriptionId": { "type": "string" }, "userId": { "type": "string" }, "uuid": { "type": "string" }, "status": { "type": "string", "enum": ["success", "error"] }, "collectedEventIds": { "type": "array", "items": { "type": "string" } }, "error": { "$ref": "#/components/schemas/IncomingWebhookDto__schema0" }, "createdAt": { "type": "string" }, "customer": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/IncomingWebhookDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/IncomingWebhookDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/IncomingWebhookDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "subscription": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "connectionId": { "type": "string" }, "integrationId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string", "enum": ["data-record-created", "data-record-updated", "data-record-deleted", "connector-event"] }, "dataSource": { "type": "object", "properties": { "key": { "type": "object" }, "collectionKey": { "type": "object" }, "collectionParameters": { "type": "object" }, "udm": { "type": "object" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "path": { "type": "object" }, "defaultPath": { "type": "object" } } }, "eventKey": { "type": "string" }, "eventParameters": { "type": "object" } }, "required": ["type"] }, "status": { "type": "string", "enum": ["subscribed", "unsubscribed", "error"] }, "error": { "$ref": "#/components/schemas/IncomingWebhookDto__schema0" }, "isRealTime": { "type": "boolean" }, "requiresPull": { "type": "boolean" }, "requiresFullSync": { "type": "boolean" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "stateData": { "type": "object" }, "nextPullEventsTimestamp": { "type": "number" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "nextRefreshTimestamp": { "type": "number" }, "globalWebhookKey": { "type": "string" }, "globalWebhookEventSelector": { "type": "string" }, "incomingWebhookUri": { "type": "string" }, "webhookUri": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/IncomingWebhookDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/IncomingWebhookDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/IncomingWebhookDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/IncomingWebhookDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["userId", "id", "connectionId", "integrationId"] } }, "required": [ "id", "workspaceId", "customerId", "integrationId", "connectionId", "subscriptionId", "userId", "uuid", "status", "collectedEventIds", "createdAt" ] }, "IncomingWebhookDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/IncomingWebhookDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "IncomingWebhooksPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "workspaceId": { "type": "string" }, "customerId": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "subscriptionId": { "type": "string" }, "userId": { "type": "string" }, "uuid": { "type": "string" }, "status": { "type": "string", "enum": ["success", "error"] }, "collectedEventIds": { "type": "array", "items": { "type": "string" } }, "error": { "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0" }, "createdAt": { "type": "string" }, "customer": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "subscription": { "type": "object", "properties": { "userId": { "type": "string" }, "tenantId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "connectionId": { "type": "string" }, "integrationId": { "type": "string" }, "externalEventTypeId": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "data-record-created", "data-record-updated", "data-record-deleted", "connector-event" ] }, "dataSource": { "type": "object", "properties": { "key": { "type": "object" }, "collectionKey": { "type": "object" }, "collectionParameters": { "type": "object" }, "udm": { "type": "object" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "path": { "type": "object" }, "defaultPath": { "type": "object" } } }, "eventKey": { "type": "string" }, "eventParameters": { "type": "object" } }, "required": ["type"] }, "status": { "type": "string", "enum": ["subscribed", "unsubscribed", "error"] }, "error": { "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0" }, "isRealTime": { "type": "boolean" }, "requiresPull": { "type": "boolean" }, "requiresFullSync": { "type": "boolean" }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "stateData": { "type": "object" }, "nextPullEventsTimestamp": { "type": "number" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "nextRefreshTimestamp": { "type": "number" }, "globalWebhookKey": { "type": "string" }, "globalWebhookEventSelector": { "type": "string" }, "incomingWebhookUri": { "type": "string" }, "webhookUri": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "internalId": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "credentials": { "type": "object" }, "lastActiveAt": { "type": "string" }, "isTest": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true }, "createdAt": { "type": "string" }, "archivedAt": { "type": "string" } }, "required": ["id", "name", "internalId"] }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["userId", "id", "connectionId", "integrationId"] } }, "required": [ "id", "workspaceId", "customerId", "integrationId", "connectionId", "subscriptionId", "userId", "uuid", "status", "collectedEventIds", "createdAt" ] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "IncomingWebhooksPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/IncomingWebhooksPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "IntegrationApiResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/IntegrationApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationApiResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/IntegrationApiResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/IntegrationApiResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "spec": { "type": "object" }, "appUri": { "type": "string" }, "isConnected": { "type": "boolean" } }, "required": ["name"] }, "IntegrationApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/IntegrationApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "IntegrationApiResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IntegrationApiResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/IntegrationApiResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/IntegrationApiResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationApiResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "IntegrationExportResponseDto": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "logoUri": { "type": "string" }, "externalAppUuid": { "type": "string" }, "oAuthCallbackUri": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "string", "enum": [""] } ] }, "logoBase64": { "type": "string" }, "connectorVersion": { "type": "string" }, "connectorUuid": { "type": "string" }, "connectorKey": { "description": "Key of the connector; alternative to connectorId. Resolved to connectorId by the API.", "type": "string" }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["uuid", "key"] }, "IntegrationsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "userId": { "type": "string" }, "tenantId": { "type": "string" }, "type": { "type": "string", "enum": ["connector", "mcp"] }, "key": { "type": "string" }, "isTest": { "type": "boolean" }, "connected": { "type": "boolean" }, "disconnected": { "description": "Use `connected` instead.", "type": "boolean", "deprecated": true }, "isDefunct": { "type": "boolean" }, "state": { "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto__schema0" } }, "requestError": { "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto__schema0" }, "error": { "description": "Use `requestError` and `errors` instead.", "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto__schema0", "deprecated": true }, "integrationId": { "type": "string" }, "connectorId": { "type": "string" }, "externalAppId": { "type": "string" }, "connectorVersion": { "type": "string" }, "authOptionKey": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastActiveAt": { "type": "string" }, "nextCredentialsRefreshAt": { "type": "string" }, "nextRetryTimestamp": { "type": "string" }, "retryAttempts": { "type": "number" }, "canTest": { "type": "boolean" }, "canRefreshCredentials": { "type": "boolean" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "buildingAgentSessionId": { "description": "Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.", "type": "string" }, "clientAction": { "description": "Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.", "type": "object", "properties": { "type": { "type": "string", "enum": ["connect", "provide-input"] }, "description": { "type": "string" }, "uiUrl": { "type": "string" }, "agentInstructions": { "type": "string" }, "handoffAgentInstructions": { "type": "string" } }, "required": ["type", "description"] } }, "required": ["id", "name", "userId", "createdAt", "updatedAt"] }, "spec": { "type": "object" }, "appUri": { "type": "string" }, "isConnected": { "type": "boolean" } }, "required": ["name"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "IntegrationsPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "IntegrationsPaginatedResponseDto__schema1": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto__schema1" } }, "items": { "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto__schema1" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto__schema1" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationsPaginatedResponseDto__schema1" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ListExternalApiLogsResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "customerId": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "statusCode": { "type": "number" }, "isSuccess": { "type": "boolean" }, "s3Uri": { "type": "string" }, "createdAt": { "type": "string" }, "requestUrl": { "type": "string" }, "duration": { "type": "number" } }, "required": [ "id", "workspaceId", "customerId", "integrationId", "connectionId", "statusCode", "isSuccess", "s3Uri", "createdAt", "requestUrl", "duration" ] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "ListOrgWorkspacesResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "orgId": { "type": "string" }, "key": { "type": "string", "description": "Unique workspace key" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "logoUri": { "description": "URI for the workspace logo", "type": "string" }, "limits": { "type": "object", "properties": { "parallelEventPulls": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelIncrementalEventPullsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelFullSyncEventPullsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelFlowRuns": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelFlowRunsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelApiRequests": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelSseRequests": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelBackgroundJobs": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelEventProcessingJobs": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelEventProcessingJobsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelInstantTasksActiveJobs": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelAgentSessions": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelCustomCodeRuns": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "ParallelWriteDatabaseRequests": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "fileUploadsMbPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "workspaceElementCreationsPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "workspaceElementCreationsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "workspaceElementSearchIndexingPerMinute": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "mcpOAuthAuthorizationsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "mcpOAuthTokensPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfCustomers": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfConnections": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfWorkspaceElements": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfWorkspaceDatabaseRecords": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "flowRunsQueueSizePerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "instantTasksQueueSize": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "QueuedTasksQueueSize": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelApiRequestsPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelBackgroundJobsPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelCustomCodeRunsPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfDatabaseEntitiesPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerCustomerPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerCustomerPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerCustomerPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerCustomerPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "externalEventsPerCustomerPerDay": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "defaultTenantAiCreditsRolling30DayLimit": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] } } }, "settings": { "type": "object", "properties": { "enableApiLogs": { "type": "boolean" }, "enableWebhookLogs": { "type": "boolean" }, "enableActionRunLogs": { "type": "boolean" }, "disableSecretKeyAuth": { "type": "boolean" }, "useMembraneUniverse": { "type": "boolean" }, "useRemoteRepository": { "type": "boolean" }, "autoGenerateIntegrationsFromConnectors": { "type": "boolean" }, "autoGenerateIntegrationsFromExternalApps": { "type": "boolean" }, "autoGenerateIntegrationsFromWebSearch": { "type": "boolean" } } }, "publicKeys": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "publicKey": { "type": "string" } }, "required": ["name", "publicKey"] } }, "userFieldsSchema": { "type": "object" }, "webhookUri": { "type": "string" }, "enabledWebhookEvents": { "type": "array", "items": { "type": "string" } }, "alertDeliverySettings": { "type": "object", "properties": { "alertTypes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "internal": { "type": "boolean", "enum": [true] }, "webhook": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] }, "email": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] } }, "required": ["internal"] }, "required": [ "fileUploadsMbPerHour", "apiRequestsPerSecond", "apiRequestsPerHour", "webhookRequestsPerSecond", "webhookRequestsPerHour", "workspaceElementCreationsPerSecond", "workspaceElementCreationsPerHour", "workspaceElementSearchIndexingPerMinute", "externalEventsPerCustomerPerDay", "apiRequestsPerCustomerPerSecond", "apiRequestsPerCustomerPerHour", "webhookRequestsPerCustomerPerSecond", "webhookRequestsPerCustomerPerHour", "parallelApiRequestsPerCustomer", "engineCreditsExhaustionProjected", "engineCreditsExhaustionActual", "aiCreditsDebtAccumulated", "totalNumberOfDatabaseEntitiesPerCustomer", "totalNumberOfCustomers", "totalNumberOfConnections", "totalNumberOfWorkspaceElements", "totalNumberOfWorkspaceDatabaseRecords", "instantTasksQueueSize", "queuedTasksQueueSize", "flowRunsQueueSizePerConnection", "eventsProcessingQueueSizePerConnection", "parallelApiRequests", "testAlert" ] } } }, "jwksUri": { "type": "string", "nullable": true }, "type": { "description": "Workspace type (production or development)", "type": "string", "enum": ["production", "development"] }, "isReadOnly": { "description": "Whether the workspace is in read-only mode", "type": "boolean" } }, "required": ["id", "name", "orgId", "key", "createdAt", "updatedAt"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "LogsDto": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "customerId": { "type": "string" }, "integrationId": { "type": "string" }, "connectionId": { "type": "string" }, "externalAppId": { "type": "string" }, "statusCode": { "type": "number" }, "isSuccess": { "type": "boolean" }, "s3Uri": { "type": "string" }, "createdAt": { "type": "string" }, "requestUrl": { "type": "string" }, "duration": { "type": "number" } }, "required": [ "id", "workspaceId", "customerId", "integrationId", "connectionId", "statusCode", "isSuccess", "s3Uri", "createdAt", "requestUrl", "duration" ] }, "OrgWorkspaceCreateDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the workspace", "minLength": 1 }, "logoUri": { "type": "string", "description": "URI for the workspace logo" }, "orgId": { "type": "string", "description": "Organization ID to create the workspace in" } }, "required": ["orgId"] }, "OrgWorkspaceDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "orgId": { "type": "string" }, "key": { "type": "string", "description": "Unique workspace key" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "logoUri": { "description": "URI for the workspace logo", "type": "string" }, "limits": { "type": "object", "properties": { "parallelEventPulls": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelIncrementalEventPullsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelFullSyncEventPullsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelFlowRuns": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelFlowRunsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelApiRequests": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelSseRequests": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelBackgroundJobs": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelEventProcessingJobs": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelEventProcessingJobsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelInstantTasksActiveJobs": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelAgentSessions": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelCustomCodeRuns": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "ParallelWriteDatabaseRequests": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "fileUploadsMbPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "workspaceElementCreationsPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "workspaceElementCreationsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "workspaceElementSearchIndexingPerMinute": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "mcpOAuthAuthorizationsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "mcpOAuthTokensPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfCustomers": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfConnections": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfWorkspaceElements": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfWorkspaceDatabaseRecords": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "flowRunsQueueSizePerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "instantTasksQueueSize": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "QueuedTasksQueueSize": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelApiRequestsPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelBackgroundJobsPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelCustomCodeRunsPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfDatabaseEntitiesPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerCustomerPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerCustomerPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerCustomerPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerCustomerPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "externalEventsPerCustomerPerDay": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "defaultTenantAiCreditsRolling30DayLimit": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] } } }, "settings": { "type": "object", "properties": { "enableApiLogs": { "type": "boolean" }, "enableWebhookLogs": { "type": "boolean" }, "enableActionRunLogs": { "type": "boolean" }, "disableSecretKeyAuth": { "type": "boolean" }, "useMembraneUniverse": { "type": "boolean" }, "useRemoteRepository": { "type": "boolean" }, "autoGenerateIntegrationsFromConnectors": { "type": "boolean" }, "autoGenerateIntegrationsFromExternalApps": { "type": "boolean" }, "autoGenerateIntegrationsFromWebSearch": { "type": "boolean" } } }, "publicKeys": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "publicKey": { "type": "string" } }, "required": ["name", "publicKey"] } }, "userFieldsSchema": { "type": "object" }, "webhookUri": { "type": "string" }, "enabledWebhookEvents": { "type": "array", "items": { "type": "string" } }, "alertDeliverySettings": { "type": "object", "properties": { "alertTypes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "internal": { "type": "boolean", "enum": [true] }, "webhook": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] }, "email": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] } }, "required": ["internal"] }, "required": [ "fileUploadsMbPerHour", "apiRequestsPerSecond", "apiRequestsPerHour", "webhookRequestsPerSecond", "webhookRequestsPerHour", "workspaceElementCreationsPerSecond", "workspaceElementCreationsPerHour", "workspaceElementSearchIndexingPerMinute", "externalEventsPerCustomerPerDay", "apiRequestsPerCustomerPerSecond", "apiRequestsPerCustomerPerHour", "webhookRequestsPerCustomerPerSecond", "webhookRequestsPerCustomerPerHour", "parallelApiRequestsPerCustomer", "engineCreditsExhaustionProjected", "engineCreditsExhaustionActual", "aiCreditsDebtAccumulated", "totalNumberOfDatabaseEntitiesPerCustomer", "totalNumberOfCustomers", "totalNumberOfConnections", "totalNumberOfWorkspaceElements", "totalNumberOfWorkspaceDatabaseRecords", "instantTasksQueueSize", "queuedTasksQueueSize", "flowRunsQueueSizePerConnection", "eventsProcessingQueueSizePerConnection", "parallelApiRequests", "testAlert" ] } } }, "jwksUri": { "type": "string", "nullable": true }, "type": { "description": "Workspace type (production or development)", "type": "string", "enum": ["production", "development"] }, "isReadOnly": { "description": "Whether the workspace is in read-only mode", "type": "boolean" } }, "required": ["id", "name", "orgId", "key", "createdAt", "updatedAt"] }, "OrgWorkspacePatchDto": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "logoUri": { "type": "string" }, "limits": { "type": "object", "properties": { "parallelEventPulls": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelIncrementalEventPullsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelFullSyncEventPullsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelFlowRuns": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelFlowRunsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelApiRequests": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelSseRequests": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelBackgroundJobs": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelEventProcessingJobs": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelEventProcessingJobsPerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelInstantTasksActiveJobs": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelAgentSessions": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelCustomCodeRuns": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "ParallelWriteDatabaseRequests": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "fileUploadsMbPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "workspaceElementCreationsPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "workspaceElementCreationsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "workspaceElementSearchIndexingPerMinute": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "mcpOAuthAuthorizationsPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "mcpOAuthTokensPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfCustomers": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfConnections": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfWorkspaceElements": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfWorkspaceDatabaseRecords": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "flowRunsQueueSizePerConnection": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "instantTasksQueueSize": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "QueuedTasksQueueSize": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelApiRequestsPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelBackgroundJobsPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "parallelCustomCodeRunsPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "totalNumberOfDatabaseEntitiesPerCustomer": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerCustomerPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "apiRequestsPerCustomerPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerCustomerPerSecond": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "webhookRequestsPerCustomerPerHour": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "externalEventsPerCustomerPerDay": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] }, "defaultTenantAiCreditsRolling30DayLimit": { "type": "object", "properties": { "value": { "type": "number" }, "defaultValue": { "type": "number" }, "unit": { "type": "string", "enum": ["number", "msec", "Mb"] } }, "required": ["unit"] } } }, "settings": { "type": "object", "properties": { "enableApiLogs": { "type": "boolean" }, "enableWebhookLogs": { "type": "boolean" }, "enableActionRunLogs": { "type": "boolean" }, "disableSecretKeyAuth": { "type": "boolean" }, "useMembraneUniverse": { "type": "boolean" }, "useRemoteRepository": { "type": "boolean" }, "autoGenerateIntegrationsFromConnectors": { "type": "boolean" }, "autoGenerateIntegrationsFromExternalApps": { "type": "boolean" }, "autoGenerateIntegrationsFromWebSearch": { "type": "boolean" } } }, "publicKeys": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "publicKey": { "type": "string" } }, "required": ["name", "publicKey"] } }, "userFieldsSchema": { "type": "object" }, "webhookUri": { "type": "string" }, "enabledWebhookEvents": { "type": "array", "items": { "type": "string" } }, "alertDeliverySettings": { "type": "object", "properties": { "alertTypes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "internal": { "type": "boolean", "enum": [true] }, "webhook": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] }, "email": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] } }, "required": ["internal"] }, "required": [ "fileUploadsMbPerHour", "apiRequestsPerSecond", "apiRequestsPerHour", "webhookRequestsPerSecond", "webhookRequestsPerHour", "workspaceElementCreationsPerSecond", "workspaceElementCreationsPerHour", "workspaceElementSearchIndexingPerMinute", "externalEventsPerCustomerPerDay", "apiRequestsPerCustomerPerSecond", "apiRequestsPerCustomerPerHour", "webhookRequestsPerCustomerPerSecond", "webhookRequestsPerCustomerPerHour", "parallelApiRequestsPerCustomer", "engineCreditsExhaustionProjected", "engineCreditsExhaustionActual", "aiCreditsDebtAccumulated", "totalNumberOfDatabaseEntitiesPerCustomer", "totalNumberOfCustomers", "totalNumberOfConnections", "totalNumberOfWorkspaceElements", "totalNumberOfWorkspaceDatabaseRecords", "instantTasksQueueSize", "queuedTasksQueueSize", "flowRunsQueueSizePerConnection", "eventsProcessingQueueSizePerConnection", "parallelApiRequests", "testAlert" ] } } }, "jwksUri": { "type": "string", "nullable": true }, "type": { "type": "string", "description": "Workspace type (production or development)", "enum": ["production", "development"] }, "isReadOnly": { "type": "boolean", "description": "Whether the workspace is in read-only mode" } } }, "OrgWorkspacesImportResultDto": { "type": "object", "properties": { "exportJobId": { "type": "string" }, "importJobIds": { "type": "array", "items": { "type": "string" } } }, "required": ["exportJobId", "importJobIds"] }, "PackageApiResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PackageApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } }, "isCustomized": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "version": { "type": "string" }, "changelog": { "type": "string" }, "parentPackageVersion": { "type": "string" }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PackageApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } }, "isCustomized": { "type": "boolean" }, "isPublic": { "type": "boolean" } }, "required": ["id", "name", "key"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PackageApiResponse__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } } }, "required": ["id", "name", "key"] }, "PackageApiResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PackageApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } }, "isCustomized": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "version": { "type": "string" }, "changelog": { "type": "string" }, "parentPackageVersion": { "type": "string" }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PackageApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } }, "isCustomized": { "type": "boolean" }, "isPublic": { "type": "boolean" } }, "required": ["id", "name", "key"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PackageApiResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } } }, "required": ["id", "name", "key"] }, "PackageApiResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/PackageApiResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "PackageApiResponse__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/PackageApiResponse__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "PackageExportProperties": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationUuid": { "type": "string" }, "parentUuid": { "type": "string" }, "externalAppUuid": { "type": "string" }, "isCustomized": { "type": "boolean" }, "isUniversal": { "type": "boolean" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["uuid", "type"] } } }, "required": ["uuid", "key"] }, "PackageVersionsResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "string" }, "changelog": { "type": "string" }, "parentPackageVersion": { "type": "string" } }, "required": ["id", "version"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "PackagesPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PackagesPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } }, "isCustomized": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "version": { "type": "string" }, "changelog": { "type": "string" }, "parentPackageVersion": { "type": "string" }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PackagesPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } }, "isCustomized": { "type": "boolean" }, "isPublic": { "type": "boolean" } }, "required": ["id", "name", "key"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PackagesPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } } }, "required": ["id", "name", "key"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "PackagesPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/PackagesPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "PatchAgentSessionDto": { "type": "object", "properties": { "state": { "type": "string", "enum": ["busy", "idle"] }, "lastActivityAt": { "type": "string", "description": "Last meaningful session progress timestamp used for inactivity timeout checks." }, "title": { "type": "string" }, "summary": { "type": "string" }, "error": { "$ref": "#/components/schemas/PatchAgentSessionDto__schema0" }, "opencodeSessionUuid": { "type": "string" }, "output": { "type": "object", "additionalProperties": { "type": "object" } }, "status": { "type": "string", "enum": ["queued", "starting", "running", "completed", "failed", "cancelled"] } } }, "PatchAgentSessionDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/PatchAgentSessionDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "PatchExternalEventSubscriptionRequestDto": { "type": "object", "properties": { "webhookUri": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "string", "enum": [""] } ] } } }, "PatchUserWorkspaceSettingsDto": { "type": "object", "properties": {} }, "PublicConnectorsPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "uuid": { "type": "string" }, "externalAppId": { "type": "string" }, "name": { "type": "string" }, "logoUri": { "type": "string" }, "appUri": { "description": "Site URL of the linked external app, denormalized onto public connector listings.", "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "isPublic": { "type": "boolean" }, "popularity": { "type": "number" }, "tenantId": { "type": "string" }, "archivedAt": { "description": "When set, the connector is archived (soft-deleted).", "type": "string" }, "baseUri": { "type": "string" }, "revision": { "type": "string" }, "dataCollectionsCount": { "type": "number" }, "operationsCount": { "type": "number" }, "eventsCount": { "type": "number" }, "udms": { "type": "array", "items": { "type": "string" } }, "hasTest": { "type": "boolean" }, "hasAuthTest": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "hasData": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "version": { "type": "string" }, "credentialsSchema": { "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" }, "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" }, "parametersSchema": { "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "options": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" }, "parametersSchema": { "description": "JSON Schema for connector-level parameters configured per integration (e.g. region, account ID).", "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript" ] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "ui": { "description": "[INTERNAL] Deprecated: Use inputSchema instead", "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" }, "description": { "type": "string" }, "helpUri": { "type": "string" } } }, "title": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "object" }, "credentialsSchema": { "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" } } } } }, "required": ["id", "key", "uuid", "name", "logoUri", "version"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "PublicConnectorsPaginatedResponseDto__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" } }, "items": { "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/PublicConnectorsPaginatedResponseDto__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "PublicPackagesPaginatedResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PublicPackagesPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } }, "isCustomized": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "version": { "type": "string" }, "changelog": { "type": "string" }, "parentPackageVersion": { "type": "string" }, "appliedToIntegrations": { "type": "array", "items": { "type": "object", "properties": { "element": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string" }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PublicPackagesPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "description": "When set, the element is archived (soft-deleted). Archived elements cannot be patched.", "type": "string" }, "isDeactivated": { "description": "When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).", "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } }, "isCustomized": { "type": "boolean" }, "isPublic": { "type": "boolean" } }, "required": ["id", "name", "key"] }, "integration": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal database ID of the element. Assigned by the API; unique per element." }, "name": { "type": "string", "description": "Display name. Always present in API responses (filled by API if not set on create)." }, "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "state": { "description": "Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.", "type": "string", "enum": [ "BUILDING", "CLIENT_ACTION_REQUIRED", "CONFIGURATION_ERROR", "SETUP_FAILED", "READY", "DISCONNECTING" ] }, "errors": { "description": "Validation or setup errors when state is not READY.", "type": "array", "items": { "$ref": "#/components/schemas/PublicPackagesPaginatedResponseDto__schema0" } }, "revision": { "description": "Opaque revision token; changes on each update. Used for optimistic concurrency.", "type": "string" }, "createdAt": { "description": "ISO date when the element was created.", "type": "string" }, "updatedAt": { "description": "ISO date when the element was last updated.", "type": "string" }, "archivedAt": { "type": "string" }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "description": "When true, the element cannot be modified (e.g. published package elements or elements from another workspace).", "type": "boolean" }, "logoUri": { "type": "string" }, "connectorId": { "type": "string" }, "connectorVersion": { "type": "string" }, "oAuthCallbackUri": { "type": "string" }, "parameters": { "type": "object" }, "hasMissingParameters": { "type": "boolean" }, "hasDocumentation": { "type": "boolean" }, "hasOperations": { "type": "boolean" }, "operationsCount": { "type": "number" }, "hasData": { "type": "boolean" }, "dataCollectionsCount": { "type": "number" }, "hasEvents": { "type": "boolean" }, "eventsCount": { "type": "number" }, "hasGlobalWebhooks": { "type": "boolean" }, "hasUdm": { "type": "boolean" }, "isTest": { "type": "boolean" }, "externalAppId": { "type": "string" }, "authType": { "type": "string", "enum": [ "integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy" ] }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } }, "required": ["id", "name", "logoUri"] } }, "required": ["element", "integration"] } } }, "required": ["id", "name", "key"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "PublicPackagesPaginatedResponseDto__schema0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/PublicPackagesPaginatedResponseDto__schema0" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "PutConnectorFileResponseDto": { "type": "object", "properties": { "path": { "type": "string", "description": "The actual file path where the file was saved" } }, "required": ["path"] }, "RotateOrgWorkspaceSecretResponseDto": { "type": "object", "properties": { "secret": { "type": "string", "description": "The new workspace secret" } }, "required": ["secret"] }, "RunFieldMappingRequestDto": { "type": "object", "properties": { "direction": { "type": "string", "enum": ["import", "export", "both"] }, "input": { "type": "object" }, "connectionId": { "type": "string" } } }, "RunFieldMappingResponseDto": { "type": "object", "properties": { "output": { "type": "object" } } }, "RunFlowRequestDto": { "type": "object", "properties": { "nodeKey": { "type": "string" }, "input": { "type": "object" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "SearchAppsResponseDto": { "type": "object", "properties": { "apps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "required": ["name", "url"] } } }, "required": ["apps"] }, "SearchResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "elementType": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["elementType", "element"] } }, "cursor": { "type": "string" } }, "required": ["items"] }, "SemanticSearchResponseDto": { "type": "array", "items": { "type": "object", "properties": { "elementType": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["elementType", "element"] } }, "SetIntegrationParametersDto": { "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "UpdateAction": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.", "type": "string" }, "instanceKey": { "description": "Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "inputSchema": { "description": "JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.", "$ref": "#/components/schemas/UpdateAction__schema0" }, "type": { "description": "Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.", "type": "string", "enum": [ "list-data-records", "find-data-record-by-id", "match-data-record", "create-data-record", "find-or-create-data-record", "update-data-record", "delete-data-record", "search-data-record", "connector-operation", "api-request-to-external-app", "api-request-to-your-app", "http-request", "run-javascript", "api-request" ] }, "config": { "description": "Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema.", "type": "object", "properties": {}, "additionalProperties": { "type": "object" } }, "outputMapping": { "description": "Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time." }, "customOutputSchema": { "description": "Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.", "$ref": "#/components/schemas/UpdateAction__schema0" }, "intent": { "description": "[Experimental] Intent-based instruction for an agent to configure this element.", "type": "string" } } }, "UpdateAction__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UpdateAction__schema0" } }, "items": { "$ref": "#/components/schemas/UpdateAction__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/UpdateAction__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateAction__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "UpdateAppEventTypeDto": { "type": "object", "properties": { "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "key": { "type": "string" }, "uuid": { "type": "string" }, "description": { "type": "string" }, "schema": { "type": "object" }, "example": { "type": "object" }, "tenantIdFormula": { "type": "object" }, "userIdFormula": { "type": "object" }, "subscribeRequest": { "type": "object", "properties": { "method": { "type": "string" }, "uri": { "type": "string" }, "body": { "type": "object" }, "query": { "type": "object" }, "headers": { "type": "object" } }, "required": ["uri"] } } }, "UpdateConnectedProductRequestDto": { "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string", "enum": ["ai-agent", "app"] }, "audience": { "type": "string", "enum": ["personal", "customers"] }, "parameters": { "type": "object", "properties": { "agentType": { "type": "string" } }, "additionalProperties": { "type": "object" } } } }, "UpdateConnectionDto": { "type": "object", "properties": { "type": { "type": "string", "enum": ["connector", "mcp"] }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "authOptionKey": { "type": "string" }, "key": { "type": "string", "minLength": 1, "maxLength": 100, "nullable": true }, "integrationId": { "type": "string" }, "integrationUuid": { "type": "string" }, "integrationKey": { "type": "string" }, "connectorId": { "type": "string" }, "connectorUuid": { "type": "string" }, "connectorKey": { "type": "string" }, "connectorVersion": { "type": "string" }, "externalAppId": { "type": "string" }, "externalAppUuid": { "type": "string" }, "credentials": { "type": "object" }, "connectorParameters": { "type": "object" }, "input": { "type": "object" }, "intent": { "description": "[Experimental] Intent-based instruction for an agent to configure this element.", "type": "string" } } }, "UpdateConnectorDto": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "logoUri": { "type": "string" }, "externalAppId": { "type": "string" }, "externalAppUuid": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/UpdateConnectorDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/UpdateConnectorDto__schema0" }, "parametersSchema": { "$ref": "#/components/schemas/UpdateConnectorDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "options": { "description": "Map of auth option key to auth configuration, for connectors that support multiple auth methods. Mutually exclusive with the top-level auth fields: use either the top-level fields (single-auth) OR `options` (multi-auth), not both.", "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "description": "Authentication protocol used by the connector.", "type": "string", "enum": ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"] }, "customCredentialsSchema": { "description": "Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).", "$ref": "#/components/schemas/UpdateConnectorDto__schema0" }, "inputSchema": { "description": "JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).", "$ref": "#/components/schemas/UpdateConnectorDto__schema0" }, "parametersSchema": { "description": "JSON Schema for connector-level parameters configured per integration (e.g. region, account ID).", "$ref": "#/components/schemas/UpdateConnectorDto__schema0" }, "getCredentialsFromConnectionParameters": { "description": "Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refreshCredentials": { "description": "Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "makeApiClient": { "description": "Function that configures the HTTP client used by operations, actions and data sources. Typically a `mapping` type with `baseUri` and auth header wiring.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getOAuthConfig": { "description": "OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getTokenData": { "description": "OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromAccessTokenResponse": { "description": "OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "getCredentialsFromRefreshTokenResponse": { "description": "OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "test": { "description": "Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint).", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "disconnect": { "description": "Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.", "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "proxyKey": { "description": "For `type: \"proxy\"` — identifies which proxy configuration the workspace should use.", "type": "string" }, "ui": { "description": "[INTERNAL] Deprecated: Use inputSchema instead", "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/UpdateConnectorDto__schema0" }, "description": { "type": "string" }, "helpUri": { "type": "string" } } }, "title": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "object" } } } } } }, "UpdateConnectorDto__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UpdateConnectorDto__schema0" } }, "items": { "$ref": "#/components/schemas/UpdateConnectorDto__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/UpdateConnectorDto__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateConnectorDto__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "UpdateCustomerAsAdminDto": { "type": "object", "properties": { "internalId": { "type": "string" }, "name": { "type": "string" }, "fields": { "type": "object" }, "credentials": { "type": "object" }, "aiCreditsRolling30DayLimit": { "type": "number", "minimum": 0, "nullable": true } } }, "UpdateDataLinkTableDto": { "type": "object", "properties": { "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } }, "key": { "type": "string" }, "uuid": { "type": "string" }, "description": { "type": "string" }, "archivedAt": { "type": "string" } } }, "UpdateDataSource": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "dataSourceId": { "type": "string" }, "universalDataSourceId": { "type": "string" }, "udm": { "type": "string" }, "pullUpdatesIntervalSeconds": { "type": "number" }, "fullSyncIntervalSeconds": { "type": "number" }, "collectionKey": { "type": "string" }, "collectionParameters": { "type": "object" }, "path": { "deprecated": true, "type": "string" }, "defaultPath": { "deprecated": true, "type": "string" } } }, "UpdateExternalAppDto": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "description": "Machine key (e.g., \"attio\"). Unique per workspace." }, "name": { "type": "string", "minLength": 1, "description": "Human-readable app name (e.g., \"Attio\")." }, "appUri": { "type": "string", "description": "App's main URL (e.g., \"https://attio.com\").", "format": "uri" }, "logoUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" } } }, "UpdateExternalEventType": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "schema": { "$ref": "#/components/schemas/UpdateExternalEventType__schema0" }, "parametersSchema": { "$ref": "#/components/schemas/UpdateExternalEventType__schema0" }, "example": { "type": "object" }, "type": { "type": "string", "enum": ["webhook"] }, "subscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "unsubscribe": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "handle": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } }, "refresh": { "type": "object", "properties": { "type": { "type": "string", "enum": ["mapping", "operation-mapping", "rest-api-mapping", "graphql-api-mapping", "javascript"] } }, "additionalProperties": { "type": "object" } } } }, "UpdateExternalEventType__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UpdateExternalEventType__schema0" } }, "items": { "$ref": "#/components/schemas/UpdateExternalEventType__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/UpdateExternalEventType__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateExternalEventType__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "UpdateFieldMapping": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "fieldMappingId": { "type": "string" }, "universalFieldMappingId": { "type": "string" }, "dataSourceId": { "type": "string" }, "dataSourceUuid": { "type": "string" }, "appSchema": { "$ref": "#/components/schemas/UpdateFieldMapping__schema0" }, "direction": { "type": "string", "enum": ["import", "export", "both"] }, "defaultImportValue": { "type": "object" }, "defaultExportValue": { "type": "object" }, "importValue": { "type": "object" }, "exportValue": { "type": "object" }, "unifiedImportValue": { "type": "object" }, "unifiedExportValue": { "type": "object" }, "frozenImportFields": { "type": "object" }, "frozenExportFields": { "type": "object" }, "frozenUnifiedExportFields": { "type": "object" } } }, "UpdateFieldMapping__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UpdateFieldMapping__schema0" } }, "items": { "$ref": "#/components/schemas/UpdateFieldMapping__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/UpdateFieldMapping__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateFieldMapping__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "UpdateFlow": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "type": "string" }, "instanceKey": { "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "flowId": { "type": "string" }, "universalFlowId": { "type": "string" }, "parametersSchema": { "$ref": "#/components/schemas/UpdateFlow__schema0" }, "parameters": { "type": "object" }, "enabled": { "type": "boolean" }, "nodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "config": { "type": "object" }, "concurrency": { "type": "number" }, "onError": { "type": "string", "enum": ["stop", "continue"] }, "ui": { "type": "object" }, "inputSchema": { "type": "object" }, "outputSchema": { "type": "object" }, "outputExample": { "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object" }, "name": { "type": "string" } } } }, "isCustomized": { "type": "boolean" }, "state": { "type": "string", "enum": ["SETUP_FAILED", "READY"] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateFlow__schema1" } }, "userConfig": { "type": "object" }, "testInput": { "type": "object" }, "dependencies": { "type": "array", "items": { "type": "object" } } } } }, "autoCreateInstances": { "type": "boolean" } } }, "UpdateFlow__schema0": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "format": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UpdateFlow__schema0" } }, "items": { "$ref": "#/components/schemas/UpdateFlow__schema0" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/UpdateFlow__schema0" } ] }, "enum": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "referenceRecords": { "type": "array", "items": { "type": "object" } }, "referenceCollection": { "type": "object", "properties": { "key": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } }, "referenceUdm": { "type": "string" }, "default": { "type": "object" }, "allowCustom": { "type": "boolean" }, "$ref": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "maxItems": { "type": "number" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "examples": { "type": "array", "items": { "type": "object" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateFlow__schema0" } }, "isImplied": { "type": "boolean" }, "isSensitive": { "type": "boolean" }, "referenceCollectionPath": { "type": "string" }, "referenceCollectionUri": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "UpdateFlow__schema1": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bad_request", "connection", "configuration", "dependency_error", "flow_run", "flow_instance_setup", "concurrency", "internal", "action_run", "action_instance_setup", "unit_run", "custom_code", "insufficient_credit", "openrouter_not_configured" ] }, "key": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" }, "stack": { "type": "object" }, "causedByError": { "$ref": "#/components/schemas/UpdateFlow__schema1" }, "logs": { "type": "array", "items": { "type": "object" } } }, "required": ["message"] }, "UpdateIntegrationDto": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type." }, "key": { "type": "string", "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create." }, "name": { "type": "string", "description": "Display name. Optional on create; used to generate key when key is omitted." }, "description": { "type": "string", "description": "Optional human-readable description." }, "meta": { "type": "object", "description": "Optional key-value metadata.", "additionalProperties": { "type": "object" } }, "logoUri": { "type": "string" }, "externalAppId": { "type": "string", "description": "External app id; alternative to connectorId — resolves to the app's default connector." }, "externalAppUuid": { "type": "string" }, "oAuthCallbackUri": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "string", "enum": [""] } ] }, "logoBase64": { "type": "string" }, "connectorVersion": { "type": "string" }, "connectorId": { "type": "string", "description": "ID of the connector this integration uses." }, "connectorUuid": { "type": "string" }, "connectorKey": { "type": "string", "description": "Key of the connector; alternative to connectorId. Resolved to connectorId by the API." }, "parameters": { "type": "object", "description": "Connector-specific parameters (e.g. OAuth { clientId, clientSecret, scopes }).", "additionalProperties": { "type": "object" } }, "optionsConfig": { "type": "object", "additionalProperties": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } } } } } } }, "UpdatePackage": { "type": "object", "properties": { "uuid": { "description": "Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.", "type": "string" }, "key": { "description": "Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.", "type": "string" }, "name": { "description": "Display name. Optional on create; used to generate key when key is omitted.", "type": "string" }, "description": { "description": "Optional human-readable description.", "type": "string" }, "meta": { "description": "Optional key-value metadata.", "type": "object", "additionalProperties": { "type": "object" } }, "integrationId": { "description": "Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.", "type": "string" }, "integrationUuid": { "description": "UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.", "type": "string" }, "integrationKey": { "description": "Key of the integration; alternative to integrationId. Resolved to integrationId by the API.", "type": "string" }, "parentId": { "description": "Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.", "type": "string" }, "parentUuid": { "description": "UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.", "type": "string" }, "parentKey": { "description": "Key of the parent element; alternative to parentId. Resolved to parentId by the API.", "type": "string" }, "connectionId": { "description": "Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.", "type": "string" }, "instanceKey": { "description": "Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.", "type": "string" }, "isUniversal": { "description": "When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.", "type": "boolean" }, "externalAppId": { "description": "Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.", "type": "string" }, "externalAppUuid": { "description": "UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.", "type": "string" }, "externalAppKey": { "description": "Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.", "type": "string" }, "scenarioTemplateId": { "type": "string" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "customer", "app", "connector", "integration", "flow", "flow-instance", "flow-run", "action", "package", "action-instance", "connection", "field-mapping", "field-mapping-instance", "data-source", "data-source-instance", "data-link-table", "data-link-table-instance", "app-event-type", "app-event-subscription", "app-event-log-record", "app-data-schema", "app-data-schema-instance", "external-event-subscription", "external-event-log-record", "external-event-pull", "external-event-type", "screen", "action-run-log-record", "external-api-log-record", "incoming-webhook-log-record", "connected-product" ] }, "element": { "type": "object" } }, "required": ["id", "type"] } } } }, "WebSearchRequestDto": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1 } }, "required": ["query"] } } }, "security": [ { "bearer": [] } ] }