Magpai

Todo-List Steps

Create task checklists that pause the workflow until completed.

Overview

Todo-list steps create a checklist of tasks that team members must complete before the workflow continues. Each item can be checked off independently, and the step tracks completion history.

Use case: Perfect for quality checklists, setup procedures, or any process that requires multiple manual steps to be completed.

Configuration

PropertyTypeDescription
namestringDisplay name for the step
itemsarrayList of todo items
disabledboolean?Skip this step when running

Todo Item Structure

Each item in the list has an ID and description:

PropertyTypeDescription
idstringUnique identifier for the item
textstringTask description

Example Configuration

{
  "id": "launch-checklist",
  "type": "todo-list",
  "name": "Pre-Launch Checklist",
  "items": [
    {
      "id": "item-1",
      "text": "Review final content for accuracy"
    },
    {
      "id": "item-2",
      "text": "Verify all links are working"
    },
    {
      "id": "item-3",
      "text": "Test on mobile devices"
    },
    {
      "id": "item-4",
      "text": "Get stakeholder sign-off"
    },
    {
      "id": "item-5",
      "text": "Schedule social media posts"
    }
  ]
}

Runtime State

During execution, each item tracks its completion state and history:

{
  "schemaVersion": 1,
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "items": [
    {
      "id": "item-1",
      "text": "Review final content",
      "done": true,
      "updatedAt": "2024-01-15T10:15:00Z"
    },
    {
      "id": "item-2",
      "text": "Verify all links",
      "done": false,
      "updatedAt": "2024-01-15T10:00:00Z"
    }
  ],
  "history": [
    { "timestamp": "...", "action": "init" },
    { "timestamp": "...", "itemId": "item-1", "done": true, "action": "update" }
  ]
}

Execution Behavior

  • Workflow pauses with status "needs-approval" when reaching a todo-list step
  • Notifications are sent if configured (uses "todo-list" trigger)
  • Team members can check off items independently
  • All items must be checked for the step to complete
  • If the list is empty, the step completes immediately
  • Completion history is tracked with timestamps

Notifications

Todo-list steps can trigger notifications when the checklist is presented. Configure the todo-list trigger in your workflow's notification settings.

See Notifications for setup details.

Common Use Cases

Quality Assurance

Verification steps before publishing content or launching features.

Onboarding

Setup tasks for new clients, team members, or projects.

Compliance

Required steps that must be completed for regulatory compliance.

Handoffs

Tasks to complete when transferring work between teams.

Best Practices

  • Keep task descriptions clear and actionable
  • Use unique IDs for each item (helps with tracking)
  • Order tasks in the sequence they should be completed
  • Don't include too many items - break into multiple lists if needed
  • Enable notifications so assigned users are alerted

Related