Documentation

`waymaker migrate`

Bring data from Stripe, HubSpot or Notion into a Waymaker Table, once or on a schedule. Connect the service, choose what to bring in, and point it at a table.

These three are the only services migrate supports. There is no migrate source for Trello, Asana, Monday.com, Jira, Airtable, Salesforce or file imports. For those, see Bringing Tasks In From Another Tool.

Usage

waymaker migrate <command> [options]

Command	What it does
`connect <service>`	Connect Stripe, HubSpot or Notion with an API key
`schema <service>`	Show the objects and fields a service offers
`preview <connectionId>`	Preview records from a connection
`sync create`	Create a sync from a service object into a table
`sync run <syncId>`	Run a sync now
`sync cancel <syncId>`	Cancel a running sync
`sync delete <syncId>`	Delete a sync configuration
`list`	List your sync configurations
`status <syncId>`	Check a sync's status

What You Can Bring In

Service	Objects
`stripe`	customers, invoices, subscriptions, charges, products
`hubspot`	contacts, companies, deals, tickets
`notion`	databases, pages, users

Run waymaker migrate schema <service> to see each object's fields.

Connect a Service

waymaker migrate connect hubspot --api-key <your-hubspot-token> --name "HubSpot CRM"

Option	Required	Description
`--api-key <key>`	Yes	The service's API key or access token
`--name <name>`	No	A name for the connection (default: `<service> connection`)

The command prints the Connection ID. You'll need it to preview and to create a sync.

Preview Records

waymaker migrate preview <connectionId> --object contacts --limit 5

Option	Required	Description
`--object <name>`	Yes	The object to preview, for example `contacts`
`--limit <number>`	No	How many records to show (default: 10)

Create a Sync

A sync copies one object from a connection into a Waymaker Table. Create the table first with waymaker tables create.

waymaker migrate sync create \
  --connection <connectionId> \
  --source contacts \
  --target <tableId> \
  --name "HubSpot contacts" \
  --schedule "0 */6 * * *"

Option	Required	Description
`--connection <id>`	Yes	The Connection ID from `migrate connect`
`--source <object>`	Yes	The object to sync, for example `contacts` or `deals`
`--target <tableId>`	Yes	The Waymaker Table to sync into
`--name <name>`	No	A name for the sync
`--mode <mode>`	No	`incremental` (default) or `full`
`--schedule <cron>`	No	A cron schedule for automatic runs, for example `"0 /6 * *"` (every 6 hours)

Run, Check and Manage Syncs

waymaker migrate list                         # all sync configurations
waymaker migrate sync run <syncId>            # run now
waymaker migrate status <syncId>              # check progress (add --json for scripts)
waymaker migrate sync cancel <syncId>         # stop a running sync
waymaker migrate sync delete <syncId> --confirm

sync delete requires --confirm.

waymaker migrate