Cuppa API

Content Generation Completed

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

Payload

application/json

eventstring · enumOptionalPossible values:

Responses

200

Acknowledge receipt of the webhook

No content

Payload

{
  "event": "content.generation_completed",
  "data": {
    "id": "text",
    "is_draft": true,
    "status": "initializing",
    "title": "text",
    "content": "text",
    "snippet": "text",
    "project_id": "text",
    "site_id": "123e4567-e89b-12d3-a456-426614174000",
    "meta_description": "text",
    "featured_images": [
      {
        "url": "text",
        "alt": "text"
      }
    ],
    "content_type": "article",
    "settings": {
      "model": "text",
      "target_keyword": "text",
      "language": "text",
      "region": "text"
    },
    "created_at": "2026-05-15T04:02:21.612Z",
    "updated_at": "2026-05-15T04:02:21.612Z"
  }
}

Content Generation Failed

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

Payload

application/json

eventstring · enumOptionalPossible values:

Responses

200

Acknowledge receipt of the webhook

No content

Payload

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

Project Export Completed

This webhook is triggered when a bulk export to an external system (e.g., Airtable) completes. It provides details about the export including the number of articles exported and any errors.

Payload

application/json

eventstring · enumOptionalPossible values:

Responses

200

Acknowledge receipt of the webhook

No content

Payload

{
  "event": "project.export_completed",
  "data": {
    "project_id": "text",
    "destination": "airtable",
    "total_articles": 1,
    "exported_articles": 1,
    "status": "complete",
    "errors": [
      "text"
    ]
  }
}