FleetConnector Documentation

Step 1: Get Your Onfleet API Key

1. Log in to your Onfleet dashboard at onfleet.com/dashboard
2. Navigate to Settings → API & Webhooks
3. Click "Create New API Key"
4. Give it a descriptive name (e.g., "WooCommerce Integration")
5. Copy the generated API key immediately (you won't be able to see it again)

Step 2: Configure in WooCommerce

1. In WordPress admin, go to WooCommerce → FleetConnector
2. Find the "Onfleet API Settings" section
3. Paste your Onfleet API key in the "Onfleet API Key" field
4. Click "Test Connection" to verify (should show your organization name)
5. Click "Load Teams" to fetch your available Onfleet teams
6. Select a default team from the dropdown (optional but recommended)
7. Click "Save Changes" at the bottom of the page

Enable Auto-Create

Check the "Automatically create Onfleet tasks" checkbox to enable automatic task creation when WooCommerce orders reach specific statuses.

Select Trigger Statuses

Choose which WooCommerce order statuses should trigger Onfleet task creation:

You can also select other statuses like On-Hold, Pending Payment, or any custom statuses you've created.

Auto-Sync Updates

When enabled, any changes to a WooCommerce order automatically update the corresponding Onfleet task.

Delete on Cancel

When enabled, cancelling a WooCommerce order automatically deletes the task in Onfleet.

Supported Delivery Date Plugins

Custom Field Configuration

If you use a custom delivery date field:

1. Select "Custom field" from the Delivery Date Plugin dropdown
2. Enter the meta key in the "Custom Date Field" input (e.g., _my_delivery_date)
3. Save changes

Webhook URL

Copy this URL to configure webhooks in your Onfleet dashboard:

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

Webhook signing secret (recommended)

Optional. Paste the webhook secret from your Onfleet dashboard (Settings → API & Webhooks). Every incoming webhook is then checked against the X-Onfleet-Signature header (HMAC-SHA512); a webhook with a missing or wrong signature is rejected.

Order Status Mappings

Configure what happens to WooCommerce orders when Onfleet tasks change status:

Save Driver Information

When enabled, FleetConnector saves driver name and ID to the order when a task is assigned in Onfleet.

Show Onfleet Status Column

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

Only Create Tasks for Shipping Orders

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

Clear Activity Logs

Remove all FleetConnector activity logs from the dashboard. This clears the log history but does not affect your orders or Onfleet tasks.

Clean Up All Task IDs

Remove all Onfleet task ID references from your WooCommerce orders. This breaks the link between orders and their Onfleet tasks.

From Order Actions Dropdown

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

From Order Edit Screen

1. Open any WooCommerce order
2. Look for the "Onfleet Task Information" meta box on the right side
3. Click the "Create Onfleet Task" button
4. The task will be created and the meta box will update with task 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 Onfleet Tasks" 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

On a product

Edit the product and open the Onfleet tab in the “Product data” box. It has these fields:

Variations use the settings of their parent product.

On a product category

Go to Products → Categories and add or edit a category. The same fields are shown at the bottom of the form:

A product in several categories combines them: the strongest order type, a linked pickup when one of the categories has it, the most days and the first date field found.

Or a date from the order

With a “Pickup date field”, the pickup date is read from that order field instead, for example the end date that a rental or booking plugin stores on the order. It is read in the same way as the delivery date, with the same “Date order in custom fields” setting (see 2.5).

The Onfleet box on the order

Orders list

Dashboard and order notes

Step 1: Get Your Webhook URL

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

Step 2: Configure in Onfleet

1. Log in to your Onfleet dashboard
2. Go to Settings → API & Webhooks
3. Click "Add Webhook"
4. Paste your webhook URL in the URL field
5. Select which events you want to receive (see section 5.2)
6. Click "Create Webhook"
7. Onfleet will test the connection automatically

Step 3: Add the webhook secret (recommended)

1. In your Onfleet dashboard, go to Settings → API & Webhooks and copy the webhook secret
2. In WordPress, paste it into Webhook signing secret (recommended) in the “Webhook Settings” section
3. Click “Save Changes”

From then on, every webhook must carry a valid X-Onfleet-Signature header (HMAC-SHA512). See “Webhook security” below.

Step 4: Verify Configuration

Test your webhook by:

• Creating a test order in WooCommerce
• Creating an Onfleet task for that order
• Completing the task in Onfleet (or changing its status)
• Checking that the WooCommerce order status updates automatically
• Verifying the event appears in the FleetConnector Dashboard logs

Log Columns

Filtering and Search

Use the filters at the top of the log to find specific events:

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
4. Open in Excel, Google Sheets, or any spreadsheet application

How to Retry

1. Filter the log to show only "Error" status events
2. Find the failed task you want to retry
3. Click "View Details" to see the error message
4. If the issue is resolved (e.g., API is back online), click "Retry"
5. The system will attempt to create the task again

Details Include

Automatic Formatting

Country code from the order

The examples above are for an order in the Netherlands. The country calling code comes from the order’s country: the shipping country, or the billing country when the phone number came from the billing details.

Detection Priority

How Time Windows Work

FleetConnector combines the detected date with your configured time window:

Available Filters

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

add_filter('fc_delivery_date_meta_keys', function($keys) {
    // Add your custom delivery date field
    $keys[] = '_custom_delivery_date';
    return $keys;
});

add_filter('fc_phone_country_code', function($calling_code, $country) {
    // Orders without a country: assume the Netherlands
    if ($country === '') {
        return '31';
    }
    return $calling_code;
}, 10, 2);

add_filter('fc_excluded_shipping_methods', function($methods) {
    $methods[] = 'my_pickup_method';
    return $methods;
});

add_filter('fc_task_additional_info', function($info, $order) {
    // Add custom order information
    $info[] = 'Customer type: ' . $order->get_meta('_customer_type');
    return $info;
}, 10, 2);

add_filter('fc_linked_pickup_date', function($date, $order, $delivery_date, $info) {
    // Never collect on a Sunday: move the pickup to Monday
    if ($date && date('N', strtotime($date)) == 7) {
        return date('Y-m-d', strtotime($date . ' +1 day'));
    }
    return $date;
}, 10, 4);

Available Actions

add_action('fc_task_created', function($task_id, $order, $result) {
    // Send custom notification, log to external system, etc.
    error_log('Task created: ' . $task_id . ' for order #' . $order->get_id());
}, 10, 3);

add_action('fc_task_updated', function($task_id, $order, $result) {
    // Handle task update
    error_log('Task updated: ' . $task_id);
}, 10, 3);

add_action('fc_task_creation_failed', function($order, $exception) {
    // Send alert, create support ticket, etc.
    error_log('Task creation failed for order #' . $order->get_id() . ': ' . $exception->getMessage());
}, 10, 2);

add_action('fc_webhook_task_completed', function($order_id, $task_data) {
    // Custom processing when delivery is completed
    $order = wc_get_order($order_id);
    $order->add_order_note('Delivery completed via Onfleet');
}, 10, 2);

add_action('fc_webhook_task_failed', function($order_id, $task_data) {
    // Handle delivery failure
    $order = wc_get_order($order_id);
    $order->add_order_note('Delivery failed - requires attention');
}, 10, 2);

Table: wp_fleetconnector_logs

Order Meta Keys (order types and linked pickups)

Product and Category Meta Keys (linked pickups)

Before Contacting Support

How to Contact Us