Configure Fleetio Integration – ClearPathGPS

Note:

A ClearPathGPS Pro Edition subscription is required. Please contact your ClearPathGPS Sales Representative for more information.
Please contact your Fleetio Sales Representative for information regarding which Fleetio subscription required for advanced Fleetio features : e.g. DTC Code reporting.

ClearPathGPS Tech support is happy to help undertake these configuration steps.
Just email or call for assistance!

Odometer : ClearPathGPS updates Fleetio's odometer reading every time the ignition is turned off.
DTC Codes : Diagnostic Trouble Codes are automatically added to Fleetio. [Requires diagnostic capable ClearPathGPS vehicle tracker].
Fueling Location : ClearPathGPS automatically adds the vehicle's location to Fleetio fueling events

Steps 1-3 are performed in Fleetio by the Account Owner
Step 4 should be completed within your ClearPathGPS account
Steps 5-8 can be completed by the ClearPathGPS support team once API keys are provided to them.

The Account Owner creates an API Key. In Fleetio : Click on your account name in the top left corner
Click User Settings
In the top right, click Manage API Keys
Click +New API Key, and name the key 'ClearPathGPS'
- Note: The key must be spelled as one word without spaces, 'ClearPathGPS' in order for this to work. For example these will not work: clearpath gps, clear path Gps, Clear Path GPS, etc. Upper and Lower cases do not matter
Copy and paste the API Key and Account Token in a separate document, you will need these in Steps 5, 6 & 7

On the "External Vehicle IDs" screen from Step 2, click the 3-dot menu button to the right of "clearpathgps"
Select Assign Vehicles
In the ClearPathGPS colum, you will need to enter your Vehicle's ID number found in the ClearPathGPS portal. To obtain this number:
- Log into your ClearPathGPS portal
- Navigate to Admin -> Vehicle Admin
- Your Vehicle ID begins with 'cp' and is followed by a six digit number. (For example, cp012345.) Take note of this number for each vehicle you wish to assign
Enter the Vehicle ID# in the box next to the vehicle, and click the blue check mark/box on the right side. A green message will appear when successful.

In ClearPathGPS Add a Vehicle Group called "fleetio".

Administration -> Group Admin at the bottom of the screen in the "Group ID" box type "fleetio", click New
Click Edit
Name the Group "Fleetio"

Assign Vehicle(s) to the Group "Fleetio" that you data from ClearPathGPS being sent over to Fleetio for.

Administration -> Vehicle Admin
Select the vehicle to add to the Fleetio Group
Click Edit
At the bottom of the page, under 'Group Membership,' Check the "Fleetio" Group box
Click Change to save your changes

Create a rule (Administration -> Rule Admin)
- The rule must be named : x-api-fleetio-odo
Edit the rule with the following settings:
- Notification Email : <Leave Blank>
- System Rule : n/a
- Active : Yes
- Cron Rule : Daily
- Description : Fleetio Integration - Odometer
- Rule Selector : $InGroup("fleetio")
- Trigger Action : Check Only "Queue"
- Minimum Interval : 0 Seconds
- Interval Reset : Yes
- Predefined Actions : <Leave Blank>
- EMail Subject : <Leave Blank>
- EMail Message (replace the appropriate TEXT below with the KEY and TOKEN you obtained in Step 1 :

{
"apiAuth":"API KEY PROVIDED BY Fleetio",
"apiToken":"API TOKEN PROVIDED BY Fleetio",
"odo":"${odometer}"
}

Remember :

Notifications must be enabled for the rule to send the vehicle's odometer to Fleetio. Check the setting : Admin->Vehicle Admin->Select Vehicle->Edit->Notify Enable (Yes)

Create a rule (Administration -> Rule Admin)
- The rule must be named : x-api-fleetio-dtc
Edit the rule with the following settings:
- Notification Email : <Leave Blank>
- System Rule : n/a
- Active : Yes
- Cron Rule : No
- Description : Fleetio Integration - DTC
- Rule Selector : $InGroup("fleetio")
- Trigger Action : Check Only "Queue"
- Minimum Interval : 0 Seconds
- Interval Reset : Yes
- Predefined Actions : <Leave Blank>
- EMail Subject : <Leave Blank>
- EMail Message (replace the appropriate TEXT below with the KEY and TOKEN you obtained in Step 1):

{
"apiAuth":"API KEY PROVIDED BY Fleetio",
"apiToken":"API TOKEN PROVIDED BY Fleetio",
"faultCodes":"${faultCodes}"
}

Create a rule (Administration -> Rule Admin)
- The rule must be named : x-api-fleetio-fuel
Edit the rule with the following settings:
- Notification Email : <Leave Blank>
- System Rule : n/a
- Active : Yes
- Cron Rule : Daily
- Description : Fleetio - Fueling Location Updates
- Rule Selector : $InGroup("fleetio")
- Trigger Action : Check Only "Queue"
- Minimum Interval : 0 Seconds
- Interval Reset : Yes
- Predefined Actions : <Leave Blank>
- EMail Subject : <Leave Blank>
- EMail Message (replace the appropriate TEXT below with the KEY and TOKEN you obtained in Step 1:

{
"apiAuth":"API KEY PROVIDED BY Fleetio",
"apiToken":"API TOKEN PROVIDED BY Fleetio"
}

Create a rule (Administration -> Rule Admin)
- The rule must be named : x-api-fleetio-location
Edit the rule with the following settings:
- Notification Email : <Leave Blank>
- System Rule : n/a
- Active : Yes
- Cron Rule : No
- Description : Fleetio Integration - Location
- Rule Selector : $InGroup("fleetio") && lat != 0 && lon != 0
- Trigger Action : Check Only "Queue"
- Minimum Interval : 0 Seconds
- Interval Reset : Yes
- Predefined Actions : <Leave Blank>
- EMail Subject : <Leave Blank>
- EMail Message (replace the appropriate TEXT below with the KEY and TOKEN you obtained in Step 1):

{
"apiAuth":"API KEY PROVIDED BY Fleetio",
"apiToken":"API TOKEN PROVIDED BY Fleetio",
"lat":"${latitude}",
"lon":"${longitude}"
}