FleetConnector Spoke Documentation

Step 1: Get Your Spoke API Key

1. Log in to your Spoke (Circuit) dashboard
2. Navigate to Settings → API
3. Click "Generate API Key" or copy your existing key
4. Copy the generated API key

Step 2: Configure in WooCommerce

1. In WordPress admin, go to WooCommerce → FleetConnector Spoke
2. Find the "Spoke API Settings" section
3. Paste your Spoke API key in the "Spoke API Key" field
4. Click "Test Connection" to verify (should show your organization name)
5. Click "Save Changes" at the bottom of the page

Enable Auto-Create

Check the "Automatically create Spoke stops" checkbox to enable automatic stop creation when WooCommerce orders reach specific statuses.

Select Trigger Statuses

Choose which WooCommerce order statuses should trigger Spoke stop creation:

Auto-Sync Updates

When enabled, any changes to a WooCommerce order automatically update the corresponding Spoke stop.

Delete on Cancel

When enabled, cancelling a WooCommerce order automatically deletes the stop in Spoke.

Supported Delivery Date Plugins

Webhook URL

Copy this URL to configure webhooks in your Spoke dashboard:

You'll configure this in Chapter 4 (Webhooks).

Order Status Mappings

Configure what happens to WooCommerce orders when Spoke stops change status:

Save Driver Information

When enabled, FleetConnector Spoke saves driver name and ID to the order when a stop is assigned.

Show Spoke Status Column

Control whether the Spoke status column appears in your WooCommerce orders list.

Only Create Stops for Shipping Orders

When enabled, automatic stop creation only triggers for orders that require shipping. Virtual products, downloadable products, and local pickup orders will be skipped.

From Order Actions Dropdown

1. Go to WooCommerce → Orders
2. Hover over an order in the list
3. Click on "Create Spoke Stop" from the row actions
4. The stop will be created immediately and you'll see a success message

From Order Edit Screen

1. Open any WooCommerce order
2. Look for the "Spoke Delivery" meta box on the right side
3. Click the "Create Spoke Stop" button
4. The stop will be created and the meta box will update with stop details

How to Use Bulk Actions

1. Go to WooCommerce → Orders
2. Check the boxes next to the orders you want to process
3. Select "Create Spoke Stops" from the Bulk Actions dropdown at the top
4. Click "Apply"
5. Wait for the processing to complete - you'll see a success message with the count

Information Displayed

Available Actions

Status Indicators

Step 1: Get Your Webhook URL

1. In WordPress admin, go to WooCommerce → FleetConnector Spoke
2. Scroll to the "Webhook Settings" section
3. Copy the webhook URL displayed (it will look like https://yoursite.com/wp-json/fleetconnector-spoke/v1/webhook)

Step 2: Configure in Spoke

1. Log in to your Spoke dashboard
2. Go to Settings → Webhooks
3. Click "Add Webhook"
4. Paste your webhook URL in the URL field
5. Select which events you want to receive (see section 4.2)
6. Click "Create Webhook"

Log Columns

How to Export

1. Apply any filters you want (date range, status, etc.)
2. Click the "Export to CSV" button at the top of the dashboard
3. The filtered results will download as a CSV file

How to Retry

1. Filter the log to show only "Error" status events
2. Find the failed stop you want to retry
3. Click "Retry" to attempt creation again

Available Filters

add_filter('fcs_stop_data_before_create', function($stop_data, $order) {
    $stop_data['notes'] .= "\nCustom info: " . $order->get_meta('_custom_field');
    return $stop_data;
}, 10, 2);

add_filter('fcs_phone_country_code', function($code) {
    return '+1'; // US country code
});

Available Actions

add_action('fcs_stop_created', function($stop_id, $order, $result) {
    error_log('Stop created: ' . $stop_id . ' for order #' . $order->get_id());
}, 10, 3);

add_action('fcs_webhook_stop_completed', function($order, $data) {
    $order->add_order_note('Delivery completed via Spoke');
}, 10, 2);

Table: wp_fcs_stop_logs

Order Meta Keys

Before Contacting Support

How to Contact Us