Webhooks

Available on Business and above. Currently, the webhooks are only triggered for the content generated via the API.

Content Generation Completed

This webhook is triggered when the content generation is completed. It provides the generated content and its status.

Payload

eventstring · enumOptionalPossible values:

Responses

200

Acknowledge receipt of the webhook

Payload

{
  "event": "content.generation_completed",
  "data": {
    "id": "text",
    "is_draft": true,
    "status": "initializing",
    "title": "text",
    "content": "text",
    "snippet": "text",
    "project_id": "text",
    "meta_description": "text",
    "featured_images": [
      {
        "url": "text",
        "alt": "text"
      }
    ],
    "content_type": "article",
    "settings": {
      "model": "text",
      "target_keyword": "text",
      "language": "text",
      "region": "text"
    },
    "created_at": "2025-06-18T20:05:17.566Z",
    "updated_at": "2025-06-18T20:05:17.566Z"
  }
}

Content Generation Failed

This webhook is triggered when the content generation fails. It provides the error details.

Payload

eventstring · enumOptionalPossible values:

Responses

200

Acknowledge receipt of the webhook

Payload

{
  "event": "content.generation_failed",
  "data": {
    "id": "text",
    "is_draft": true,
    "status": "initializing",
    "status_extra": {
      "error": "text"
    }
  }
}