Onboarding Setup Guide

1. Enable Onboarding in the Admin Panel

2. Provide Documentation for Auto-Derived Specs

The platform can derive registration, authentication, and initial setup specs from your API docs. In the Onboarding Settings section you see three doc inputs:

• Registration docs URL/file for creating a user or account.
• Authentication docs URL/file for logging in and obtaining a token or API key.
• Initial setup docs URL/file for configuration endpoint or endpoints after registration.

For each area, you can paste a docs URL or upload a file. The system indexes those docs, extracts field names and headers, and builds a canonical request spec internally.

3. Generate or Paste cURL Commands

Under Registration, Authentication, and Initial Setup you can either paste your own cURL command for each endpoint or use the Index Docs and Generate cURL buttons to have the system draft a canonical cURL from your docs.

Internally, these cURL commands are parsed by the onboarding service to extract endpoint URL, method, headers, content type, and body keys. These specs drive calls in the registration, authentication, and initial setup functions in the onboarding service.

4. Configure Initial Setup Fields

The bot prompts users for initial setup values after registration, such as workspace name, project ID, or keys.

In the Onboarding Settings UI, Initial Fields and Initial Header Fields define what your external API expects. These map directly to the fields shown to the user in the onboarding widget and the payload assembled before calling your API.

You can also mark fields as coming from the auth token or API key, so they are injected automatically instead of being asked again.

5. Add Additional Steps

Additional steps let you chain post-setup actions such as creating a default workspace, configuring webhooks, or importing seed data.

Each additional step has a name, optional fields to collect from the user, and either an endpoint with method or a step-specific cURL command. The widget uses these definitions to collect data and the onboarding service executes the call with your stored auth token or API key.

6. Embed the Onboarding Widget

To use the onboarding-only assistant on any external page, embed the dedicated onboarding widget script.

<script
  src="https://YOUR-DOMAIN.com/api/widget/onboarding"
  data-api-key="ak_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  data-chat-title="Onboarding Assistant"
  data-theme="green"
  data-size="large"
  data-position="bottom-right"
></script>

Replace YOUR-DOMAIN.com and data-api-key with your deployment domain and admin API key.

For internal testing, you can also visit the onboarding test page at the onboarding route, paste your API key, and load the widget from inside the product.

7. Save and Test

After configuring everything in the Onboarding Settings section:

• Save your changes.
• Open your onboarding test page or embedded page and walk through the flow end to end.
• Check your external system to verify that registration, initial setup, and additional steps behave as expected.