View as Markdown
Samsara icon

Samsara ACTION

Create Route

Generates a new route to an existing address. As a prerequisite, the user must create an address using the 'create-address' action if the location is not already available in the address book. The user must provide the necessary props such as destination address.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Samsara account once, then configure and run Create Route from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "samsara-create-route",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    samsara: { authProvisionId: "apn_xxxxxxx" },
    driverId: "Driver Id",
    externalIds: "External Ids",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Route inputs
Property Type Description
driverId Driver Id string
ID of the driver.
Optional Dynamic
externalIds External Ids object
The external IDs for the given object.
Optional
name Name string
Name for the route
Required
notes Notes string
Notes about the route.
Optional
routeCompletionCondition Route Completion Condition string
Defaults to 'arriveLastStop' which ends the route upon arriving at the final stop. The condition 'departLastStop' ends the route upon departing the last stop. If 'arriveLastStop' is set, then the departure time of the final stop should not be set.
Optional
routeStartingCondition Route Starting Condition string
Defaults to 'departFirstStop' which starts the route upon departing the first stop in the route. The condition 'arriveFirstStop' starts the route upon arriving at the first stop in the route. If 'departFirstStop' is set, the arrival time of the first stop should not be set.
Optional
stops Stops object
List of objects of stops along the route. For each stop, exactly one of addressId and singleUseLocation are required. Depending on the settings on your route, either a scheduledArrivalTime or scheduledDepartureTime must be specified for the first job. See further information
Required
vehicleId Vehicle Id string
ID of the vehicle.
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
samsara-create-route
Version
0.0.3
App
Samsara
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes