Run integration tool

runIntegrationTool(input: ExecuteIntegrationToolInput!): IntegrationToolResult!

Arguments

ArgumentTypeRequired
inputExecuteIntegrationToolInput!Yes

Input fields

input

ExecuteIntegrationToolInput

FieldTypeRequiredDescription
projectReferenceStringNoProject ID or slug. Required unless the credential is bound to a project, which may omit it or name its own project. Every run needs the capability of the tool on the project: project.integrations.read, or project.integrations.connect for a tool that writes. A caller without it gets an isError result.
toolNameString!YesCatalog-selected tool. Read-only tools require the read capability even when executed through a mutation; other tools require the capability selected by the shared integration authorization policy.
runIdStringNoAgent run ID for validating run-declared integration tools.
agentIdStringNoAgent ID for validating run-declared integration tools.
connectionIdIDNo
expectedConnectionGenerationIdIDNo
argsJSONNoTool arguments. Omit or send null to call the tool with {}.

Response

Returns IntegrationToolResult!. Open the type for its fields and nested types.

FieldType
contentJSON!
structuredContentJSON
isErrorBoolean
_metaJSON

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation RunIntegrationTool($input: ExecuteIntegrationToolInput!) {
  runIntegrationTool(input: $input) {
    _meta
    content
    isError
    structuredContent
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "toolName": "example"
  }
}