What it does
Wavefront writes each approved article as a document in a collection of your self-hosted Payload CMS 3 server, through its REST API. Documents are drafts by default, or published.
A draft revision of a live document goes to its versions, and the live page stays as it was until you publish.
Before you start
- Payload CMS 3 at a public https address
- A collection with drafts turned on, and API keys enabled on the auth collection
- A user for Wavefront that can create, update and publish in the collection
How to connect Payload CMS
- In your Payload config, turn on drafts for the articles collection and API keys for the auth collection. Add a text field for Wavefront's ID.
- Create a user for Wavefront, check Enable API Key in the admin panel and copy the key.
- In Wavefront, open Settings → Publishing and choose Add destination. Pick Payload CMS.
- Enter the server URL and the API key.
- Choose Load fields, pick the collection and type the field names for title, slug and body.
- Choose Test connection. Wavefront checks the collection exists, has drafts, and that the user can create and update.
What Wavefront sends
- Title, slug, excerpt, SEO title and description, author, date and canonical URL
- The body as Lexical rich text, or Markdown on a text field
- The header image uploaded to the media collection when published
- The article's JSON-LD on a json field
Good to know
- Scheduling isn't supported.
- Without a Wavefront ID field, a publish whose answer was lost can't be retried safely and stops for a check by hand.
- Withdraw sets the document back to a draft; it stays, with its history.