/** * 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 { CustomHeadersObjectResponseBody } from './custom-headers-object-response-body'; /** * * @export * @interface WebhooksPostWebhooksResponseBody */ export interface WebhooksPostWebhooksResponseBody { /** * The list of custom headers that users can include with their request * @type {Array} * @memberof WebhooksPostWebhooksResponseBody */ 'customHeaders'?: Array; /** * The list of event types associated with a particular webhook. * @type {Array} * @memberof WebhooksPostWebhooksResponseBody */ 'eventTypes'?: Array; /** * The ID of the webhook. This will appear in both Samsara’s cloud dashboard and the API. This is the id of the webhook. This is system generated. * @type {string} * @memberof WebhooksPostWebhooksResponseBody */ 'id': string; /** * The name of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time. * @type {string} * @memberof WebhooksPostWebhooksResponseBody */ 'name': string; /** * The secret key of the webhook. This will appear in both Samsara’s cloud dashboard and the API. * @type {string} * @memberof WebhooksPostWebhooksResponseBody */ 'secretKey': string; /** * The url of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time. * @type {string} * @memberof WebhooksPostWebhooksResponseBody */ 'url': string; /** * The version of the webhook. Valid values: `2018-01-01`, `2021-06-09` * @type {string} * @memberof WebhooksPostWebhooksResponseBody */ 'version': WebhooksPostWebhooksResponseBodyVersionEnum; } export declare const WebhooksPostWebhooksResponseBodyEventTypesEnum: { readonly AddressCreated: "AddressCreated"; readonly AddressDeleted: "AddressDeleted"; readonly AddressUpdated: "AddressUpdated"; readonly AlertIncident: "AlertIncident"; readonly AlertObjectEvent: "AlertObjectEvent"; readonly DocumentSubmitted: "DocumentSubmitted"; readonly DriverCreated: "DriverCreated"; readonly DriverUpdated: "DriverUpdated"; readonly DvirSubmitted: "DvirSubmitted"; readonly EngineFaultOff: "EngineFaultOff"; readonly EngineFaultOn: "EngineFaultOn"; readonly FormSubmitted: "FormSubmitted"; readonly GatewayUnplugged: "GatewayUnplugged"; readonly GeofenceEntry: "GeofenceEntry"; readonly GeofenceExit: "GeofenceExit"; readonly IssueCreated: "IssueCreated"; readonly PredictiveMaintenanceAlert: "PredictiveMaintenanceAlert"; readonly RouteStopArrival: "RouteStopArrival"; readonly RouteStopDeparture: "RouteStopDeparture"; readonly RouteStopResequence: "RouteStopResequence"; readonly SevereSpeedingEnded: "SevereSpeedingEnded"; readonly SevereSpeedingStarted: "SevereSpeedingStarted"; readonly SuddenFuelLevelDrop: "SuddenFuelLevelDrop"; readonly SuddenFuelLevelRise: "SuddenFuelLevelRise"; readonly VehicleCreated: "VehicleCreated"; readonly VehicleUpdated: "VehicleUpdated"; }; export type WebhooksPostWebhooksResponseBodyEventTypesEnum = typeof WebhooksPostWebhooksResponseBodyEventTypesEnum[keyof typeof WebhooksPostWebhooksResponseBodyEventTypesEnum]; export declare const WebhooksPostWebhooksResponseBodyVersionEnum: { readonly _20180101: "2018-01-01"; readonly _20210609: "2021-06-09"; }; export type WebhooksPostWebhooksResponseBodyVersionEnum = typeof WebhooksPostWebhooksResponseBodyVersionEnum[keyof typeof WebhooksPostWebhooksResponseBodyVersionEnum];