Check integration readiness

integrationReadiness(projectReference: String!, name: String!, toolName: String!, connectionId: ID, expectedConnectionGenerationId: ID): SelectedIntegrationReadiness!

Requires project.integrations.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceString!YesProject ID or slug. The caller needs project.integrations.read on it. Run tokens and service accounts are refused as forbidden.
nameString!YesIntegration name, 1 to 128 characters.
toolNameString!YesQualified tool name in the namespace of the integration, 1 to 256 characters.
connectionIdIDNoExact connection to evaluate.
expectedConnectionGenerationIdIDNoObserved generation of the connection. Requires connectionId.

Response

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

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

Example

graphql
query IntegrationReadiness($projectReference: String!, $name: String!, $toolName: String!, $connectionId: ID, $expectedConnectionGenerationId: ID) {
  integrationReadiness(projectReference: $projectReference, name: $name, toolName: $toolName, connectionId: $connectionId, expectedConnectionGenerationId: $expectedConnectionGenerationId) {
    version
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "name": "example",
  "toolName": "example"
}