validateIntegration

Requires permission settings:integration:update.

Checks one integration's credentials with the service and records whether they are valid, with the error when they are not. Requires permission to update integrations.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation ValidateIntegration($input: ValidateIntegrationInput!) {
  validateIntegration(input: $input) {
    id
    displayName
    serviceName
    createdAt
    config
    description
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ValidateIntegration($input: ValidateIntegrationInput!) {\n  validateIntegration(input: $input) {\n    id\n    displayName\n    serviceName\n    createdAt\n    config\n    description\n  }\n}",
  "variables": {
    "input": {
      "id": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "id": "string"
  }
}

Response:

{
  "data": {
    "validateIntegration": {
      "id": "id",
      "displayName": "string",
      "serviceName": "AMAZON",
      "createdAt": "2025-01-15T00:00:00Z",
      "config": {},
      "description": "string"
    }
  }
}

validateIntegration(
  input: ValidateIntegrationInput!
): IntegrationSetting!

Arguments

validateIntegration.input ● ValidateIntegrationInput! non-null input

The ID of the integration to validate.

Type

IntegrationSetting object

An integration setting.