API Reference

Plugin Heartbeat

WordPress plugin heartbeat. Updates connection status and returns pending commands.

POST/api/v1/plugin/heartbeat

Receives heartbeat from the AEO WordPress plugin. Updates the CMS connection status with plugin metadata and returns any pending commands for failed push delivery.

Example

bash

curl -X POST "https:">//audit.aeocontent.ai/api/v1/plugin/heartbeat" \
  -H "Authorization: Bearer $AEO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "site_url": "https://example.com",
    "home_url": "https://example.com",
    "version": "1.2.0",
    "wp": "6.5",
    "php": "8.2",
    "features": ["faq_schema", "ai_txt", "content_licensing"]
  }'

Try it

Response

Connection status updated. Any pending commands are returned in the commands array.

200Heartbeat accepted

json

{
  class="code-string">"ok": true,
  class="code-string">"commands": [
    {
      class="code-string">"command": class="code-string">"publish_article",
      class="code-string">"payload": { class="code-string">"article_id": class="code-string">"abc-123", class="code-string">"title": class="code-string">"New Article" }
    }
  ]
}

401Missing authentication

json

{
  class="code-string">"error": class="code-string">"Missing authentication"
}

404Unknown site

json

{
  class="code-string">"error": class="code-string">"Unknown site",
  class="code-string">"domain": class="code-string">"example.com"
}

Supports two auth methods: API key (Authorization: Bearer) or HMAC-SHA256 signature (x-aeo-signature header). The HMAC method is legacy and backward compatible.