Sei
FeaturesIntegrationsFAQ
Start
  • Overview
  • WordPress
  • Custom site quick start
Reference
  • Operations
  • Webhook protocol
  • @getsei/webhook
  • @getsei/payload
Help
  • Troubleshooting
  • Changelog

Docs

Changelog

Every change to the protocol is additive: a receiver built for an older version keeps working, and ignores fields it doesn't know. ping still answers protocol: 1; the minor versions below are the packages' versions.

1.8: image dimensions (November 2026)

  • An image may carry its width and height in whole pixels: as attributes on the <img> in contentHtml and as width/height numbers on the image block in contentBlocks, each only when the article has one. Keep them on the <img>. article.list items may report them the same way, and an import keeps them; a percentage or a style still makes the article read-only in Sei.
  • @getsei/webhook 1.8.0: the SeiImageBlock type. @getsei/payload 1.6.0 keeps them as width and height on the seiImage block.
  • WordPress: images with width/height attributes (classic content, and core/image blocks as WordPress up to 6.2 saved a resized image) import editable and publish back the same; the plugin is unchanged. An image resized in WordPress 6.3+ (a style) is still read-only.

1.7: tables (November 2026)

  • An article body can hold a table: <table> in contentHtml (a header row in <thead> with <th> cells, the other rows in <tbody>), and { type: "table", header, rows } in contentBlocks, each cell a text run. Skip a block type you don't know; contentHtml always has the whole body.
  • article.list items may report tables the same way, and an import keeps them. Merged cells, captions, a header column or styles make the article read-only in Sei.
  • @getsei/webhook 1.7.0: the SeiTableBlock type. @getsei/payload 1.5.0 keeps tables as Lexical tables when the content field has EXPERIMENTAL_TableFeature, and as one paragraph per row otherwise.
  • WordPress: Sei imports and publishes core/table blocks (fixed layout, no caption); the plugin is unchanged.

1.6: social title and description, and pages (October 2026)

  • article.social: { title, description } on a full publish of an article that has them: the shared link's title and description when they differ from the SEO ones. Print them as og:title / og:description (and Twitter) tags, falling back to seoTitle and metaDescription for an empty one. Absent: leave them as they are.
  • @getsei/webhook 1.6.0 validates it. @getsei/payload 1.4.0 stores them as sei.ogTitle and sei.ogDescription.
  • The WordPress plugin (1.2) prints Open Graph and Twitter tags when no SEO plugin does, and copies the social title and description into Yoast, Rank Math, SEOPress or The SEO Framework.
  • Pages: a receiver that keeps pages too answers ping with the pages capability. Sei then imports and publishes them with kind: "page" on the article, and on article.unpublish, article.delete and article.restore; article.list items that are pages carry kind: "page". @getsei/payload 1.4.0: the pages option.

1.5: publish dates (October 2026)

  • publishedAt in the publish reply and in article.list items: when the article first went live, or null. Sei orders its Articles list's live articles by it, as the site lists them.
  • @getsei/webhook 1.5.0: the types.

1.4: preview (October 2026)

  • article.preview with the preview capability: the site renders the draft like a published article at a short-lived URL on its own host, and answers { url }. Sei shows that page as the editor's Preview.
  • @getsei/webhook 1.4.0: onPreview. @getsei/payload 1.4.0: the preview: { url(doc, token) } option and getSeiPreview(payload, token), so a Payload site's own article page renders the draft.
  • Sei's preview badge links to the site's own preview URL ("Open on your site"), where the page's scripts run.

1.3: cover image (October 2026)

  • article.featuredImage: { url, alt } on every full publish of an article with a cover. Absent: keep the article's image.
  • article.list items may report featuredImage, and an import sets the cover in Sei.
  • @getsei/webhook 1.3.0 validates it. @getsei/payload 1.3.0 adds fields.featuredImage (a text field, or an upload field it downloads into once) and fields.featuredImageAlt.

1.2: delete and restore (October 2026)

  • article.delete and article.restore, with the delete and restore capabilities.
  • The receiver decides how to delete and answers recoverable.
  • @getsei/webhook 1.2.0: onDelete, onRestore. @getsei/payload 1.2.0: the delete option (deletes for good by default, keeps the document with { field }, never with false).

1.1: categories and tags (October 2026)

  • article.categories and article.tags on every full publish (possibly empty: remove them all; absent: an older Sei, keep them).
  • terms.list and the taxonomies capability.
  • @getsei/payload 1.1.0: the taxonomies option.

1.0 (October 2026)

  • ping, article.publish (publish, draft, schedule; ifRevision, seoOnly, asNew), article.unpublish, article.list, signed as Standard Webhooks.
On this page
  • 1.8: image dimensions (November 2026)
  • 1.7: tables (November 2026)
  • 1.6: social title and description, and pages (October 2026)
  • 1.5: publish dates (October 2026)
  • 1.4: preview (October 2026)
  • 1.3: cover image (October 2026)
  • 1.2: delete and restore (October 2026)
  • 1.1: categories and tags (October 2026)
  • 1.0 (October 2026)
PrivacyTermsDocsSeiBot