Editorial Workflow Plugin for Payload CMS

A comprehensive editorial workflow plugin for Payload CMS that provides robust approval processes, notifications, and access control for content publishing.

Features

• Multi-step Approval Workflows: Define custom approval stages for your content
• Role-based Access Control: Control who can approve content at each stage
• Smart Notifications: Get notified when content needs review or has been approved
• Workflow History: Track all changes and approvals in your content lifecycle
• Customizable Stages: Define your own workflow stages to match your editorial process
• Deadline Management: Set and track content deadlines
• Comments & Feedback: Inline comments and feedback system for reviewers

Installation

npm install @harrytwigg/plugin-editorial-workflow
# or
yarn add @harrytwigg/plugin-editorial-workflow
# or
pnpm add @harrytwigg/plugin-editorial-workflow

Basic Usage

import { buildConfig } from 'payload'
import { editorialWorkflowPlugin } from '@harrytwigg/plugin-editorial-workflow'

export default buildConfig({
  plugins: [
    editorialWorkflowPlugin({
      collections: ['posts', 'pages'],
      workflows: {
        standard: {
          stages: [
            { slug: 'draft', name: 'Draft', color: '#6B7280' },
            { slug: 'review', name: 'Under Review', color: '#F59E0B' },
            { slug: 'approved', name: 'Approved', color: '#10B981' },
            { slug: 'published', name: 'Published', color: '#3B82F6' },
          ],
        },
      },
      notifications: {
        enabled: true,
        slack: {
          webhookUrl: process.env.SLACK_WEBHOOK_URL,
        },
      },
    }),
  ],
  // ... rest of config
})

Configuration

Plugin Options

• collections: Array of collection slugs to enable workflow for
• workflows: Define custom workflow configurations
• notifications: Configure notification settings
• permissions: Custom permission configurations
• ui: UI customization options

Workflow Configuration

Each workflow can define multiple stages with specific permissions and actions.

Notifications

The plugin supports various notification channels including email, Slack, and in-app notifications.

License

MIT