Here’s a step-by-step guide to configure an OAuth2 client for Samsara
This guide provides detailed instructions on integrating Samsara with your Terminal instance.
This is required for Samsara specifically in order to guarantee:
You can skip this step if you already have a Samsara developer account
support@withterminal.com
.support@withterminal.com
to your Samsara organization.To create an OAuth application with Samsara, follow these steps:
Create a new application:
Under Redirect URLs, add:
Which scopes should I choose?
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 Model | Samsara Scope |
---|---|
General (required) | Setup & Administration > Read Org Information Setup & Administration > Read Webhooks Setup & Administration > Write Webhooks |
Vehicles (required) | Vehicles > Read Vehicles |
Groups | Setup & Administration > Read Tags |
Devices | Setup & Administration > Read Gateways |
Drivers | Drivers > Read Drivers |
Vehicle Locations Vehicle Stat Logs | Vehicles > Read Vehicle Statistics Assignments > Read Assignments |
Trips | Vehicles > Read Vehicle Trips |
Trailers | Trailers > Read Trailers Equipment > Read Equipment |
Trailer Locations | Trailers > 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 Events | Safety & Compliance > Read Safety Events & Scores Safety & Cameras > Read Camera Media (optional) |
IFTA Summaries | Compliance > Read IFTA (US) |
Passthrough | Select any other scopes you plan to leverage if using passthrough |
Beta
. Learn more about app states here.support@withterminal.com
to your Samsara organization.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.
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.