Rutter Dashboard

Learn about using the Dashboard to operate your Rutter account and organization.

Creating Accounts and Logging into the Rutter Dashboard

Once an admin user has been created for your organization, your admin can invite teammates to your organization by going to the Settings page of the dashboard, and clicking "Generate Invite Link". You can send the invite link to your teammate, which they can use to create their account.

Once your account is created, you can login to Rutter Dashboard.

Don't have a Rutter account? Click here to get started!

Navigating the Dashboard

The dashboard has a few top-level routes:

  1. Dashboard Home: Find your Rutter API keys and resources for getting started.
  2. Platforms: Configure and manage your platform integrations.
  3. Connections: View your connections and filter (by status) or search (by platform, store name, id, and access token).
  4. Webhooks: Configure your webhook destinations and view webhooks sent from Rutter.
  5. Customize: See White-label your Rutter Integration.
  6. Settings: See account and organization information and if you are an admin, invite or remove teammates to and from your organization.

To toggle between production and sandbox mode, toggle the switch located at the bottom of the dashboard sidebar.

White-label your Rutter Integration

Rutter offers customization options for Rutter Link, which can be configured in the Customize page.

Custom Logo and Title

Toggle the "Title" section to write a custom title on the Rutter Link landing page, and upload a photo from your computer to have a custom logo in the Rutter Link flow.

Selecting your Platforms List

Toggle the "Platforms" section to configure which platforms will show up in the Rutter Link flow.

Click "Save" to save your Rutter Link configuration.

View your Rutter Connections

After a connection is created, either through Rutter Link or our Create a Connection Endpoint, you can find that connection in the Connections page of the dashboard. You can filter the connection status by selecting "All Connections", "Active" "Needs Maintenance", or "Syncing".

All ConnectionsAll statuses below.
ActiveConnection is successfully synced and is healthy (does not need maintenance).
Needs MaintenanceConnection is disabled or needs reauthorization.
SyncingConnection is in initial sync stage of Connection Lifecycle.


Viewing Connection Details

You can click on a row in your connections table to see the detailed view of the connection, which includes a summary of the connection info, information about the "Sync Status", and a maintenance section to help with unhealthy connections.

For select accounting platforms, the connections detailed view offers a section to export accounting data in spreadsheet (XLSX) format.

Accounting Report Generation

If you go to the connections page and select an accounting connection, the detailed view will include a section for Accounting financial report generation. You can click "Save Connection Data" to generate an accounting report in spreadsheet format (XLSX).


What’s Next