Step 1. Begin setup: sync your users.

Motive supports bidirectional synchronization of all available entities on both platforms (users, vehicles, and assets). Begin your complete TMS integration by synchronizing all the entities. We begin with users (drivers).

In the Motive system, users include drivers, dispatchers, administrators, and fleet managers (as indicated by the role parameter, which accepts the values ‘driver’, ‘fleet_user’, and ‘admin’. In our sync, we are only concerned with users where role = ‘driver’.

List Users: GET https://api.keeptruckin.com/v1/users

To ensure that all your available drivers’ IDs and other details are stored (and correct) on the Motive platform, begin by retrieving a list of drivers by calling GET https://api.keeptruckin.com/v1/users. Your call returns a list of drivers associated with your company on the Motive platform, and details about the drivers (these are numerous and include the drivers’ names and contact information, license information, and various details of their current status).

Update a User: PUT https://api.keeptruckin.com/v1/users/:id

Cross-reference the list with the data stored in your system, and synchronize the two by updating Motive's data with a PUT request to https://api.keeptruckin.com/v1/users/:id in which you update the external_id field. This is the field where we store your internal TMS ID for the driver. This way, any updates you make to our system will include your own internal IDs in addition to those Motive assigns to users.

In your update, provide one or more external_ids for each user by providing with each external_id an associated integration_name, as follows:

"external_ids":[
      {
        "external_id":"201",
        "integration_name":"generic_tms"
      },
      {
        "external_id":"DRV123",
            "integration_name":"generic_maintenance_system"
      }

Update any other necessary parameters to synchronize the two systems.

📘

Learn more

Read our reference documentation for the Users object, the GET call, and the PUT call for details.