Webhooks
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-07-03T18:38:11.104Z",
"updated_at": "2025-07-03T18:38:11.104Z"
}
}
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"
}
}
}
Last updated