Documentation

Publishing API Reference

Payload contracts and expected response semantics for PrismSEO publishing workflows.

Publishing API Reference

This reference describes the payload shape used by PrismSEO publishing workflows.

Webhook event envelope

event: string

integration_name: string

article: object

Article object fields

  • id: string
  • title: string
  • slug: string
  • content_html: string
  • excerpt: string
  • meta_title: string
  • meta_description: string
  • published_at: ISO timestamp
  • prism_css: optional string

Response behavior

  • 2xx: accepted
  • 4xx: validation or auth issue (fix payload/config)
  • 5xx: destination failure (retry safe if idempotent)

Reliability recommendations

  • Treat article.id as idempotency key.
  • Persist payload before processing.
  • Log response body for debugging repeated failures.

Next step

Apply this setup, then run your first publish cycle from your dashboard.