Add a WorkWave account
This guide walks through setting up a WorkWave account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field WorkWave expects.
At a glance
Before you start
- A WorkWave account in good standing, plus its API credentials. The required fields are listed in All WorkWave settings below.
- Decide the account country and the default service and label format this account uses.
Open the carrier accounts page
In the Carriyo Dashboard, open Settings in the left sidebar. Under Carrier Management, choose Carrier Accounts, then click the + add icon to start a new account.
Pick WorkWave
In the carrier picker, search for WorkWave and click Select. Carriyo creates a WorkWave account and opens the credential step.
Enter the basics
The first wizard page collects two fields:
- Account name
- A label that's meaningful to your team (e.g.
WorkWave your country). Keep it short and unique. - Account country
- The country this account ships from. Determines the routes and services available.
Enter your WorkWave account details
Enter the required WorkWave account details, then click Next. Every field is documented in All WorkWave settings below, with examples and accepted values.
Configure the account
The new account opens on its detail page. General settings work the same way for every carrier: the Active toggle, default label and service, and currency. See Add a carrier account for the full reference to these shared settings — default label, merchant access, going live, and common mistakes.
Merchant access
On multi-merchant tenants, restrict the account to specific merchants via the Permissions tab, then Save.
All WorkWave settings
Every field WorkWave exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
1 fieldAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Access keyRequired | Text | WorkWave Route Manager access key, sent as the X-WorkWave-Key header. Generate it in WorkWave under your account settings. |
Account Details
1 fieldAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| TerritoryRequired | Text | WorkWave Route Manager territory ID used when creating and tracking orders. Find it in the WorkWave territory settings. Example: Type territory id to be used |
Capability notes
Behavior that follows from WorkWave's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but WorkWave has to register it on their side. Share the callback details from the account page with your WorkWave contact (see step 5) — a one-time setup.