/** * Samsara API * # Overview Something new! Welcome Samsara\'s new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what\'s changed and learn how to get started.

Want to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).

*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can\'t find an API that you\'re looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*

Submit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)!
Samsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets. The Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you\'re familiar with what you can build with a REST API, then this will be your go-to API reference. Visit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview. If you have any questions, please visit https://samsara.com/help. ## Endpoints All our APIs can be accessed through HTTP requests to URLs like: ``` https://api.samsara.com/ ``` For EU customers, this URL will be: ``` https://api.eu.samsara.com/ ``` Note Legacy endpoints will have the URL: `https://api.samsara.com/v1/` or `https://api.eu.samsara.com/v1/` ## Authentication To authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings->Organization->API Tokens`. Your API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on. Authentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password: ```curl Authorization: Bearer {access_token} ``` All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail. ### OAuth2 If building an application for our marketplace, our API is accessible via. OAuth2 as well. | Type | Value | | ------------- |:-------------:| | Security scheme | OAuth2 | | OAuth2 Flow | accessCode | | Authorization URL | https://api.samsara.com/oauth2/authorize | | Token URL | https://api.samsara.com/oauth2/token | ## Common Patterns You can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures). * * The version of the OpenAPI document: 2024-11-18 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { TriggerParamsObjectRequestBody } from './trigger-params-object-request-body'; /** * The trigger of an alert. * @export * @interface WorkflowTriggerObjectRequestBody */ export interface WorkflowTriggerObjectRequestBody { /** * * @type {TriggerParamsObjectRequestBody} * @memberof WorkflowTriggerObjectRequestBody */ 'triggerParams'?: TriggerParamsObjectRequestBody; /** * The id of the trigger type. Reference the following list for the ids: Ambient Temperature = 1003 DVIR Submitted for Asset = 5005 Driver Recorded = 5027 Sudden Fuel Level Rise = 5034 Sudden Fuel Level Drop = 5035 Training Assignment Due Soon = 8003 Training Assignment Past Due = 8004 Vehicle Speed = 1000 Fuel Level (Percentage) = 1005 Vehicle DEF Level (Percentage) = 1006 Vehicle Battery = 1007 Gateway Unplugged = 1009 Dashcam Disconnected = 1012 Camera Connector Disconnected = 1046 Asset starts moving = 1013 Inside Geofence = 1014 Outside Geofence = 1020 Unassigned Driving = 1016 Driver HOS Violation = 1018 Vehicle Engine Idle = 1019 Asset Engine On = 1021 Asset Engine Off = 1022 Harsh Event = 1023 Scheduled Maintenance = 1024 Scheduled Maintenance by Odometer = 1025 Scheduled Maintenance by Engine Hours = 1026 Out of Route = 1027 GPS Signal Loss = 1032 Cell Signal Loss = 1033 Fault Code = 1029 Tire Faults = 1043 Gateway Disconnected = 1030 Panic Button = 1034 Tampering Detected = 1045 If vehicle is severely speeding (as defined by your organization) = 5022 Driver Document Submitted = 5009 Driver App Sign In = 5012 Driver App Sign Out = 5013 Geofence Entry = 5016 Geofence Exit = 5017 Route Stop ETA Alert = 5018 Scheduled Date And Time = 8001 * @type {number} * @memberof WorkflowTriggerObjectRequestBody */ 'triggerTypeId': number; }