Configure Fleetio Integration

1. Navigate to the User Profile section of Fleetio by clicking the drop down in the top left hand corner.
   
   
   
   
2. On the next page in the menu on the left, click "Manage API Keys"
   
   
   
3. Click +New API Key, and label the key 'ClearPathGPS'. Use API Version '2023-03-01' from the dropdown.
   Note: The label must be spelled as one word without spaces, 'ClearPathGPS' in order for this to work. Upper and lower cases do not matter.
   
   
4. Copy and paste the long API Key and the shorter Account Token into a separate document or keep the web page up in a separate tab. If you lose this page you should be able to come back and access the same API Key and Account Token again. You can also copy and paste the curl command at the bottom, this includes both the API Key and the Account Token.
   These will be used in later steps within your ClearPathGPS account.
   

1. Navigate back to the general settings page in Fleetio and look for the section on the left called "External Vehicle IDs"
   
   
2. In the top right, select +Add External Vehicle ID
3. Enter the following text into the fields exactly as shown below (in bold):
   Label : ClearPathGPS
   Description: ClearPathGPS Vehicle ID
   
   
4. Finally, click "Save External Vehicle ID", you should see the External Vehicle ID has been created and the 'key' should match like the one in the image below.
   

1. On the "External Vehicle IDs" page from Step 2, click the 3-dot menu button to the right of "clearpathgps" key. and select "Assign Vehicles".
   
   
2. In the ClearPathGPS colum, you will need to enter the External Vehicle ID (also called the "CP #") found in the ClearPathGPS portal.  To obtain this number:
   1. Log into your ClearPathGPS portal
   2. Navigate to Admin -> Vehicle Admin
   3. Vehicle IDs begin 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
3. Enter the CP # 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.

1. It is strongly recommended that you start by creating a group within your ClearPathGPS account called "Fleetio Assets". Steps on creating groups can be found here.
   
   
2. Add the tracking devices that you want to integrate with Fleetio to this group.
   Any devices ("CP #s") you have assigned to assets within Fleetio must be in this group, see Step 3 for details on Assigning External Vehicle IDs.
   
   
3. Next, you need to make a some 'Custom Alerts' by navigating to the Alerts page in your ClearPathGPS account.
   If you're already working with a ClearPathGPS Support representative, they may have already setup these alerts within your account. If this is the case, you should see a series of custom alerts with "Fleetio" in the name on the 'Alerts' page.
   
   
4. Steps 5-9 detail the five different Alerts that can be created depending on the data you want to send over to Fleetio.
   
   
5. To begin, select 'Create Alert' in the top right hand corner and scroll to the bottom until you see 'Custom Alert'.

1. To send over Odometer data, configure the the custom Alert exactly as detailed below, starting with 'Alert Details':
   
   1. Alert Name: x-api-fleetio-odo
   2. Applies To: Group - Fleetio Assets
   3. Status Code: All Codes
   4. Cron Option: Daily 
   5. Rule Selector:

      lat != 0 && lon != 0

   6. Minimum Interval: Leave all fields (days, hours, minutes) on the default 0
   7. Trigger Action - Email: Uncheck this box
   8. Trigger Action - Queue: Check this box
      
      
2. Click 'Next' to go to the 'Notify' page and do the following:
   
   1. Notify - via Email: Leave this field blank
   2. Notify - Email Message ("Enter Email Subject"): Leave this field blank
   3. Notify - Email Message ("Enter Email Message"): Copy and paste everything in the block below 

      {
      "apiAuth":"ADD API KEY HERE",
      "apiToken":"ADD ACCOUNT TOKEN HERE",
      "odo":"${odometer}"
      }

   4. Notify - via Text: Leave this field blank
   5. Notify - Text Message: Leave this field blank
      
3. Click 'Next' to go to the 'Finalize' page:
   1. At the top of this page (you may need to scroll up), untoggle the 'Active' button, you will come back and activate this later on.
   2. Click 'Save' and move on to Step 3.
      
      

Important: For engine hours to sync and show correctly in Fleetio you must ensure that the 'Secondary Meter' is enabled for the asset and set to engine hours. Engine hours sent from ClearPathGPS will always be stored in this field. 

1. To send over Engine Hours data, configure the the custom Alert exactly as detailed below, starting with 'Alert Details':
   
   1. Alert Name: x-api-fleetio-enghours
   2. Applies To: Group - Fleetio Assets
   3. Status Code: All Codes
   4. Cron Option: Daily 
   5. Rule Selector:

      (true)

   6. Minimum Interval: Leave all fields (days, hours, minutes) on the default 0
   7. Trigger Action - Email: Uncheck this box
   8. Trigger Action - Queue: Check this box
      
      
2. Click 'Next' to go to the 'Notify' page and do the following:
   
   1. Notify - via Email: Leave this field blank
   2. Notify - Email Message ("Enter Email Subject"): Leave this field blank
   3. Notify - Email Message ("Enter Email Message"): Copy and paste everything in the block below 

      {
      "apiAuth":"ADD API KEY HERE",
      "apiToken":"ADD ACCOUNT TOKEN HERE",
      "engHours":"${engineHours}",
      "engHoursOffset":"${engineHoursOffset}"
      }

   4. Notify - via Text: Leave this field blank
   5. Notify - Text Message: Leave this field blank
      
3. Click 'Next' to go to the 'Finalize' page:
   1. At the top of this page (you may need to scroll up), untoggle the 'Active' button, you will come back and activate this later on.
   2. Click 'Save' and move on to Step 3.
      
      

1. To send over Diagnostic Trouble Codes or Fault Codes configure the the custom Alert exactly as detailed below, starting with 'Alert Details':
   
   1. Alert Name: x-api-fleetio-dtc
   2. Applies To: Group - Fleetio Assets
   3. Status Code: OBD Fault Code
   4. Cron Option: No
   5. Rule Selector:

      (true)

   6. Minimum Interval: Leave all fields (days, hours, minutes) on the default 0
   7. Trigger Action - Email: Uncheck this box
   8. Trigger Action - Queue: Check this box
      
      
2. Click 'Next' to go to the 'Notify' page and do the following:
   
   1. Notify - via Email: Leave this field blank
   2. Notify - Email Message ("Enter Email Subject"): Leave this field blank
   3. Notify - Email Message ("Enter Email Message"): Copy and paste everything in the block below 

      {
      "apiAuth":"ADD API KEY HERE",
      "apiToken":"ADD ACCOUNT TOKEN HERE",
      "faultCodes":"${faultCodes}"
      }

   4. Notify - via Text: Leave this field blank
   5. Notify - Text Message: Leave this field blank
      
3. Click 'Next' to go to the 'Finalize' page:
   1. At the top of this page (you may need to scroll up), untoggle the 'Active' button, you will come back and activate this later on.
   2. Click 'Save' and move on to Step 3.
      
      

1. To send over Location data, configure the the custom Alert exactly as detailed below, starting with 'Alert Details':
   
   1. Alert Name: x-api-fleetio-location
   2. Applies To: Group - Fleetio Assets
   3. Status Code: All Codes
   4. Cron Option: No
   5. Rule Selector:

      lat != 0 && lon != 0

   6. Minimum Interval: Leave all fields (days, hours, minutes) on the default 0
   7. Trigger Action - Email: Uncheck this box
   8. Trigger Action - Queue: Check this box
      
      
2. Click 'Next' to go to the 'Notify' page and do the following:
   
   1. Notify - via Email: Leave this field blank
   2. Notify - Email Message ("Enter Email Subject"): Leave this field blank
   3. Notify - Email Message ("Enter Email Message"): Copy and paste everything in the block below 

      {
      "apiAuth":"ADD API KEY HERE",
      "apiToken":"ADD ACCOUNT TOKEN HERE",
      "lat":"${latitude}",
      "lon":"${longitude}"
      }

   4. Notify - via Text: Leave this field blank
   5. Notify - Text Message: Leave this field blank
      
3. Click 'Next' to go to the 'Finalize' page:
   1. At the top of this page (you may need to scroll up), untoggle the 'Active' button, you will come back and activate this later on.
   2. Click 'Save' and move on to Step 3.
      
      

1. To Geolate Fueling Events within Fleetio, configure the the custom Alert exactly as detailed below, starting with 'Alert Details':
   
   1. Alert Name: x-api-fleetio-fuel
   2. Applies To: Group - Fleetio Assets
   3. Status Code: All Codes
   4. Cron Option: Daily 
   5. Rule Selector:

      (true)

   6. Minimum Interval: Leave all fields (days, hours, minutes) on the default 0
   7. Trigger Action - Email: Uncheck this box
   8. Trigger Action - Queue: Check this box
      
      
2. Click 'Next' to go to the 'Notify' page and do the following:
   
   1. Notify - via Email: Leave this field blank
   2. Notify - Email Message ("Enter Email Subject"): Leave this field blank
   3. Notify - Email Message ("Enter Email Message"): Copy and paste everything in the block below 

      {
      "apiAuth":"ADD API KEY HERE",
      "apiToken":"ADD ACCOUNT TOKEN HERE"
      }

   4. Notify - via Text: Leave this field blank
   5. Notify - Text Message: Leave this field blank
      
3. Click 'Next' to go to the 'Finalize' page:
   1. At the top of this page (you may need to scroll up), untoggle the 'Active' button, you will come back and activate this later on.
   2. Click 'Save' and move on to Step 3.