Skip to content
CXGear CXGear Docs

Quickstart

This walkthrough takes you from an empty org to a finished job. Aim for a tiny CSV (a few rows) so you can see results quickly.

Before you start

Section titled “Before you start”
  • You can sign in (local demo often uses admin@demo.cxgear.local).
  • The API and runtime services are running. The web app alone cannot execute spinners — the runtime does.
  • On Trial, you may only create a limited number of projects and spinners (see Trial limits).

1. Sign in

Section titled “1. Sign in”

Open the app and sign in with email and password.

Screenshot needed
Login screen (empty form, no error).
Where: Login
Save as: src/assets/screenshots/03-login.png

If you see a message about a previous session, that is usually your own session after a restart. From the same computer, CXGear should replace it automatically; otherwise use Continue here.

2. Create an Outreach project

Section titled “2. Create an Outreach project”
  1. Go to Projects.
  2. Click New project.
  3. Choose Outreach.
  4. Enter a clear name (for example “Demo collection”).
  5. Click Create.
Screenshot needed
New project drawer with Outreach selected and name filled.
Where: Projects → New project
Save as: src/assets/screenshots/04-create-project.png

If creation fails with a plan limit toast above the drawer, you already used your Trial project slot. Open Billing or remove an unused project.

3. Create a data table and import rows

Section titled “3. Create a data table and import rows”
  1. Open the project → Data tables.
  2. Create a table and Import a CSV with at least name and phone (or msisdn).
  3. Confirm rows appear under Show data.
Screenshot needed
Data tables list with one table that has rows.
Where: Project → Data tables
Save as: src/assets/screenshots/05-data-tables.png

4. Mark metadata fields

Section titled “4. Mark metadata fields”

This step is easy to skip and causes most “why can’t my spinner see this column?” issues.

  1. Open Metadata for the table.
  2. Select only the columns the pipeline should use (for example name, phone).
  3. Save.

From now on, only those fields enter jobs and appear as contact context on Records.

Screenshot needed
Metadata fields picker with selected columns checked.
Where: Data tables → Metadata
Save as: src/assets/screenshots/06-metadata-fields.png

5. Build and publish a spinner

Section titled “5. Build and publish a spinner”
  1. Open Spinners → Create spinner.
  2. Select your data table (you should see metadata fields listed).
  3. Add a Log step. In the message, greet the contact using the template for the name field (double curly braces around name).
  4. Publish the spinner.

Publishing freezes the definition. Edit and publish again after changes.

Screenshot needed
Spinner builder with data table selected and one Log step visible.
Where: Spinners → Create / Edit
Save as: src/assets/screenshots/07-spinner-builder.png

6. Run the job

Section titled “6. Run the job”
  1. On the Spinners list, click Run now.
  2. Wait for the status message. Simple log steps finish quickly; AI steps can take longer.
  3. Open Jobs, select the run, and open a record — or open Records for the ops view.
Screenshot needed
Jobs page with one completed run selected and records on the right.
Where: Project → Jobs
Save as: src/assets/screenshots/08-jobs-page.png
Screenshot needed
Records page with one row selected and detail panel open.
Where: Project → Records
Save as: src/assets/screenshots/09-records-outcomes.png

Success checklist

Section titled “Success checklist”
  • Job status is completed (or shows failed records with a clear error in the journey).
  • Records show your metadata fields as contact context.
  • Optional: Pipeline journey shows the log message for each step.

If something fails

Section titled “If something fails”
ProblemWhat to check
Job stays pendingRuntime service is running
Plan limit toastTrial limits and Billing
Empty contact on RecordsMetadata fields configured; spinner re-run after that
Session expiredSign in again

Next

Section titled “Next”