agentforcePreflightCheck

Check if the site is ready for an Agentforce sync operation. Verifies that configuration has propagated to the WordPress runtime. Use this before enabling the sync button in the UI.

agentforcePreflightCheck(
  input: AgentforcePreflightCheckInput!
): AgentforcePreflightCheckPayload!

Example

Query

query ($input: AgentforcePreflightCheckInput!) {
  agentforcePreflightCheck(input: $input) {
    categoriesCount
    filterRegistered
    hasApiObject
    hasApiSource
    hasApiToken
    hasApiUrl
    ready
    syncAllPosts
  }
}

Variables

{
  "input": {
    "applicationId": 42,
    "environmentId": 42,
    "networkSiteId": 42,
    "url": "https://example.com"
  }
}

Response

{
  "data": {
    "agentforcePreflightCheck": {
      "categoriesCount": 42,
      "filterRegistered": true,
      "hasApiObject": true,
      "hasApiSource": true,
      "hasApiToken": true,
      "hasApiUrl": true,
      "ready": true,
      "syncAllPosts": true
    }
  }
}

Arguments

agentforcePreflightCheck.input ● AgentforcePreflightCheckInput! non-null input common

The application, environment, and optional network site to validate.

Type

AgentforcePreflightCheckPayload object common

Response payload for Agentforce preflight check