Docs

Sei for developers

Sei writes, scores and publishes articles. Your site keeps them. Sei connects to a site in one of two ways:

Your site How Sei connects What you install
WordPress The WordPress REST API, with an application password the site's admin approves The free GetSei plugin (optional, recommended)
Anything else (Next.js, Payload, a headless CMS, your own backend) One signed HTTPS endpoint on your site: the Sei webhook protocol @getsei/webhook (any JavaScript server) or @getsei/payload (Payload CMS 3), or about 50 lines in any language

The principle: clear defaults, everything overridable

Every operation Sei asks of your site does something sensible when you configure nothing, and each one can be changed or switched off:

  • WordPress needs no code. Publishing writes Gutenberg blocks, Delete moves posts to WordPress's Trash, the cover becomes the featured image. The plugin is only needed for the SEO fields.
  • A custom site implements only the handlers it wants. onPublish is the one required handler; leave onUnpublish, onList, onTerms, onDelete or onRestore out and Sei hides that feature for the site. Each handler decides how: Delete can remove a row for good or hide it, and the receiver tells Sei which.

Operations lists every operation with its default and how to change it.

Start here

What travels

Sei sends an article as clean semantic HTML (contentHtml) and as portable JSON blocks (contentBlocks), with its slug, SEO title, meta description, focus keyphrase, scores, categories and tags, the author when the byline is shown, and the cover image. Your site sends back its id for the article, a revision (for conflict checks) and the public URL. Sei never needs your database credentials, and your site never calls Sei: every request goes from Sei to your site, signed.