Onboard

📸 Screenshots

Here are visual examples of this section:

Onboard - Worker Configuration Interface

1. Overview and Purpose

The Onboard worker creates interactive onboarding experiences by presenting structured questions to users and collecting their responses. It manages conversation flow with configurable options, actions, and conditional logic. The worker maintains state across interactions and can generate summaries of collected information.

2. Configuration Parameters

• name: Optional identifier for the onboarding flow
• locale: Language/locale setting (defaults to "en-US")
• items: Array of onboarding questions and options that define the flow structure
• invalidOptionAnswer: Message displayed when user provides an invalid response (defaults to "Please answer using a valid option.")

3. Input/Output Handles

• input: Input handle - accepts user responses to onboarding questions
• output: Output handle - returns the next question or completion message
• summary: Output handle - provides a formatted summary of all collected responses
• finished: Output handle - boolean indicating whether the onboarding flow is complete

4. Usage Examples with Code

// Configure an onboarding flow for user preferences
const onboardWorker = {
  type: "onboard",
  parameters: {
    name: "user_preferences",
    locale: "en-US",
    items: [
      {
        id: "role",
        name: "userRole",
        title: "Role",
        question: "What is your role?",
        summarize: true,
        options: [
          { label: "Developer", answer: "developer", action: "continue" },
          { label: "Designer", answer: "designer", action: "continue" }
        ]
      }
    ]
  }
}

5. Integration Examples

The Onboard worker is ideal for user registration flows, preference collection, and guided setup processes. It integrates well with authentication systems and user profile management workflows.

6. Best Practices

• Define clear, concise questions that guide users naturally through the flow
• Use the summarize flag on important fields to include them in the final summary
• Implement proper option validation to handle unexpected user inputs gracefully
• Leverage Handlebars templating in questions to personalize the experience with previous answers

7. Troubleshooting Tips

• If questions appear out of order, check that each item has a unique name property
• When options aren't recognized, verify the label values match expected user inputs exactly
• Use the finished output to detect when the onboarding flow is complete
• Check the summary output for a formatted overview of all collected responses