Integration

Connect Payload to Blog Automation

Articles become documents of a collection in Payload CMS 3 (self-hosted). The text goes in as Lexical rich text, HTML or Markdown; the cover image goes into your media collection.

Tested with a real account

What you need for Payload

  • Payload 3 on HTTPS.
  • A users collection with auth: { useAPIKey: true } and a user for Blog Automation.
  • A collection for articles (e.g. posts) and an upload collection for images (usually media).

Step by step: connect Payload

  1. In Payload, set auth: { useAPIKey: true } on the users collection and restart Payload.
  2. Create a user for Blog Automation, tick Enable API Key and copy the key.
  3. In Blog Automation: Websites & blogs → Connect website → Payload. Enter address, users collection and key, then click Check connection.
  4. Choose the collection and type in the field names (the suggestions match Payload’s website template). Set the article text format, image collection and drafts, then click Save.

Where do I find what in Payload?

Field in Blog AutomationWhere to find it in Payload
Payload addressThe address of your Payload site, e.g. https://cms.your-company.com.
User collection of the API keyThe slug of the users collection, usually users.
API keyOn the user, under "Enable API Key".
Collection for imagesSlug of the upload collection, usually media.
Collection has drafts (versions.drafts)Tick this if the article collection has versions: { drafts: true }.

What is transferred to Payload?

Payload does not list its fields through the API - you type the field names from your schema. The article text can be written as Lexical rich text (Payload’s default editor), HTML or Markdown; the cover image is uploaded to the image collection and set as a relation.

Tips for Payload

  • Which collections are offered depends on the user’s permissions (access.create).

Good to know about Payload

  • Field names are not checked up front - a typo only shows on the first publication.
  • Without drafts in the collection every article is visible straight away.

More in the official Payload documentation (external link).

Frequently asked questions about Payload

"Payload does not know this API key"

Check "Enable API Key" on the user and the users collection in the form, then copy the key again.

"This API key may not write to any collection in Payload"

The user needs create access (access.create) on the article collection.

Ready for your first post?

Try Blog Automation with sample data

The demo opens at once, no sign-up needed. You see the dashboard, editor, calendar and approval just the way your team will use them.

Try the demo - no sign-upStart free

The demo shows sample texts. The Free plan includes 200 tokens a month.

Try the demo