Skip to main content

​
Overview

This guide provides detailed instructions on integrating Samsara with your Terminal instance. This is required for Samsara specifically in order to guarantee:
  • The OAuth flow is consistent with your branding.
  • The permissions are customized for your specific needs.
  • You can publish your application in the Samsara marketplace.

​
Creating a Developer Account

You can skip this step if you already have a Samsara developer account
  1. Submit Samsara’s partner application form.
  2. Accept the invite Samsara sends you to create a developer account. This may take up to 7 business days.
    • If you don’t receive an invite after 7 business days, reach out to support@withterminal.com.
  3. Invite support@withterminal.com to your Samsara organization.

​
Creating an OAuth Application

To create an OAuth application with Samsara, follow these steps:
  1. Create a new application:
    • Log in to your Samsara dashboard and go to the Apps tab
    • Click Create new app
    • Enter the required details (name, tag line, logo, etc.)
  2. Under Redirect URLs, add: 
https://link.withterminal.com/oauth/callback/samsara
  1. Choose the necessary Scopes for your application.
Below is a summary of the scopes you might need from Samsara, depending on the Terminal common models you intend to utilize.
It’s best to request all the permissions you might need upfront. Adding permissions later will require customers to re-authenticate, which can be avoided with early planning.
Common ModelSamsara Scope
General (required)Setup & Administration > Read Org Information
Setup & Administration > Read Webhooks
Setup & Administration > Write Webhooks
Vehicles (required)Vehicles > Read Vehicles
GroupsSetup & Administration > Read Tags
DevicesSetup & Administration > Read Gateways
DriversDrivers > Read Drivers
Vehicle Locations
Vehicle Stat Logs		Vehicles > Read Vehicle Statistics
Assignments > Read Assignments
TripsVehicles > Read Vehicle Trips
TrailersTrailers > Read Trailers
Equipment > Read Equipment
Trailer LocationsTrailers > Read Trailer Statistics
Equipment > Read Equipment Statistics
HOS Logs
HOS Daily Logs
HOS Available Time		Compliance > Read ELD Hours of Service
Compliance > Read ELD Compliance Settings
Safety EventsSafety & Compliance > Read Safety Events & Scores
Safety & Cameras > Read Camera Media (optional)
IFTA SummariesCompliance > Read IFTA (US)
PassthroughSelect any other scopes you plan to leverage if using passthrough
  1. Click Save to create your application.
  2. Click on the application you just created.
  3. In the top right, change the app state to Beta. Learn more about app states here.
  4. Click Save to make your application available for customer use.
  5. Invite support@withterminal.com to your Samsara organization.

​
Update Samsara Configuration in the Terminal Dashboard

If you haven’t obtained production access to Terminal yet, you can skip this step and complete it when you have production access.You must be a Terminal Dashboard admin to perform this step.
  1. Go to the Terminal Dashboard Settings
  2. Scroll down to Samsara
  3. Paste the Client ID and Client Secret from Samsara into the Terminal dashboard.
  4. Click Save Changes to save the configuration.
  5. Begin connecting Samsara fleets to Terminal 🚛

​
Publishing Your Application

Once your integration is in production and Samsara fleets have connected to your application, you can request that Samsara review your application for inclusion in their marketplace. Contact us when ready, and we’ll help introduce you to the Samsara team to expedite the review process.