Skip to main content
Samsara
Betav0.1.0
51 actions · 2 auth methods
Logistics

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

No app registration required. Uses a Samsara API token whose Read/Write permissions are chosen per category when the tok…

Connector Profile · OAuth 2.0

Requires creating an OAuth 2.0 app in the Samsara dashboard. Permissions are chosen on the app rather than requested at…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

Link Account · OAuth 2.0

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
51 actions
Action
Description
List All Addresses
Returns a list of all addresses in an organization.
Create An Address
Creates a new address in the organization.
Delete An Address
Delete a specific address.
Retrieve An Address
Retrieve an address in the connected Samsara organization (GET /addresses/{id})
Update An Address
Update a specific address.
List All Drivers
Get all drivers in organization.
Create A Driver
Add a driver to the organization.
Sign Out A Driver
Sign out a driver from the Samsara Driver App. Requires the Samsara Platform Premier license
Retrieve A Driver
Get information about a driver.
Update A Driver
Update a specific driver’s information.
Delete API Generated Driver-vehicle Assignments
Delete driver assignments that were created using the POST fleet/driver-vehicle-assignments endpoint for the requested…
Get All Driver-vehicle Assignments
Get all driver-vehicle assignments for the requested drivers or vehicles in the requested time range.
Update API Generated Driver-vehicle Assignments
Update driver assignments that were created using the POST fleet/driver-vehicle-assignments.
Create A New Driver-vehicle Assignment
Create a new driver-vehicle assignment in the connected Samsara organization (POST /fleet/driver-vehicle-assignments)
Get HOS Clocks
Get the current HOS status for all drivers.
Get All Driver HOS Daily Logs
Get summarized daily Hours of Service charts for the specified drivers.
Get HOS Logs
Returns HOS logs between a given startTime and endTime.
Get All Driver HOS Violations
Get active Hours of Service violations for the specified drivers.
Update The ShippingDocs Field Of An Existing Assignment
Update the shippingDocs field of an existing assignment in the connected Samsara organization (PATCH /hos/daily-logs/log…
Fetch All Routes
Fetch all routes in the connected Samsara organization (GET /fleet/routes)
Create A Route
Create a route in the connected Samsara organization (POST /fleet/routes)
Get Route Updates
Subscribes to a feed of immutable, append-only updates for routes.
Delete A Route
Delete a dispatch route and its associated stops.
Fetch A Route
Retrieve a single dispatch route, including its stops and settings, by Samsara ID or external ID
Update A Route
Update a route in the connected Samsara organization (PATCH /fleet/routes/{id})
List Routes For A Specific Plan
List routes for a specific plan in the connected Samsara organization (GET /hub/plan/routes)
List Hubs
List all hubs (planners) in the connected Samsara organization (GET /hubs)
List Plans For A Specific Hub
List all plans for a specific hub in the connected Samsara organization (GET /hub/plans)
Create A Hub Plan
Create a new plan for a hub in the connected Samsara organization (POST /hub/plan)
List All Tags
Return all of the tags for an organization.
Create A Tag
Create a new tag for the organization.
Delete A Tag
Permanently deletes a tag.
Retrieve A Tag
Retrieve a tag in the connected Samsara organization (GET /tags/{id})
Update A Tag
Partially update a tag, changing only the name, parent or member lists that are supplied
Replace A Tag
Update a tag with a new name and new members.
Get Trips Stream
This endpoint will return trips that have been collected for your organization based on the time parameters passed in.
List All User Roles
Returns a list of all user roles in an organization.
List All Users
Returns a list of all users in an organization.
Create A User
Add a user to the organization.
Delete A User
Permanently remove a dashboard user from the Samsara organization by user ID
Retrieve A User
Get a specific user’s information.
Update A User
Update a specific user’s information.
Locations Snapshot
Locations snapshot in the connected Samsara organization (GET /fleet/vehicles/locations)
Locations Feed
Locations feed in the connected Samsara organization (GET /fleet/vehicles/locations/feed)
Historical Locations
Historical locations in the connected Samsara organization (GET /fleet/vehicles/locations/history)
List All Vehicles
Returns a list of all vehicles.
Retrieve A Vehicle
Get information about a specific vehicle.
Update A Vehicle
Updates the given Vehicle object.
Stats Snapshot
Returns the last known stats of all vehicles at the given time.
Stats Feed
Follow a feed of vehicle stats.
Historical Stats
Returns vehicle stats during the given time range for all vehicles.