Samsara Configurations API

openapi: 3.2.0
info:
  description: Gain greater visibility by connecting your fleets, equipment, sites, and people.
  title: Samsara Configurations API
  version: '2024-11-18'
servers:
- url: https://api.samsara.com/
- url: https://api.eu.samsara.com/
security:
- AccessTokenHeader: []
tags:
- name: Configurations
paths:
  /alerts/configurations:
    delete:
      description: "Delete an alert configuration.\n\n <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team."
      operationId: deleteConfigurations
      parameters:
      - description: The unqiue Samsara id of the alert configuration.
        in: query
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          content: {}
          description: No Content response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsDeleteConfigurationsBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: Delete Alert Configurations.
      tags:
      - Configurations
    get:
      description: "Get specified Alert Configurations.\n\nThe following trigger types are API enabled and will show up in the results:\nVehicle Speed\nAmbient Temperature\nFuel Level (Percentage)\nVehicle DEF Level (Percentage)\nVehicle Battery\nGateway Unplugged\nDashcam Disconnected\nCamera Connector Disconnected\nAsset starts moving\nInside Geofence\nOutside Geofence\nUnassigned Driving\nDriver HOS Violation\nVehicle Engine Idle\nAsset Engine On\nAsset Engine Off\nHarsh Event\nScheduled Maintenance\nScheduled Maintenance by Odometer\nScheduled Maintenance by Engine Hours\nOut of Route\nGPS Signal Loss\nCell Signal Loss\nFault Code\nTire Faults\nGateway Disconnected\nPanic Button\nTampering Detected\nIf vehicle is severely speeding (as defined by your organization)\nDVIR Submitted for Asset\nDriver Document Submitted\nDriver App Sign In\nDriver App Sign Out\nGeofence Entry\nGeofence Exit\nRoute Stop ETA Alert\nDriver Recorded\nScheduled Date And Time\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team."
      operationId: getConfigurations
      parameters:
      - description: Filter by the IDs. Returns all if no ids are provided.
        explode: true
        in: query
        name: ids
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'The status of the alert configuration.  Valid values: `all`, `enabled`, `disabled`'
        in: query
        name: status
        schema:
          default: all
          enum:
          - all
          - enabled
          - disabled
          type: string
      - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.'
        in: query
        name: after
        schema:
          type: string
      - description: Optional boolean indicating whether to return external IDs on supported entities
        in: query
        name: includeExternalIds
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsResponseBody'
          description: OK response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetConfigurationsBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: Get Alert Configurations.
      tags:
      - Configurations
    patch:
      description: "Updates an alert configuration.\n\n <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team."
      operationId: patchConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertsPatchConfigurationsRequestBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsResponseBody'
          description: OK response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPatchConfigurationsBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: Update Alert Configurations.
      tags:
      - Configurations
      x-codegen-request-body-name: PatchConfigurationsRequestBody
    post:
      description: "Creates an alert configuration.\n\n <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team."
      operationId: postConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertsPostConfigurationsRequestBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsResponseBody'
          description: OK response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPostConfigurationsBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: Create Alert Configurations.
      tags:
      - Configurations
      x-codegen-request-body-name: PostConfigurationsRequestBody
  /preview/custom-reports/configs:
    get:
      description: "Get paginated custom report configs created in the organization.\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team."
      operationId: getCustomReportConfigs
      parameters:
      - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.'
        in: query
        name: after
        schema:
          type: string
      - description: The limit for how many reports will be in the response. Default and max for this value is 100 objects.
        in: query
        name: limit
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsResponseBody'
          description: OK response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomReportsGetCustomReportConfigsBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: '[preview] Get Custom Report Configs'
      tags:
      - Configurations
components:
  schemas:
    WebhookParamsObjectResponseBody:
      description: The webhook configuration for an Action.
      properties:
        payloadType:
          default: enriched
          description: 'This determines the alert webhook payload type to use. Learn more: https://developers.samsara.com/docs/webhook-reference.  Valid values: `legacy`, `enriched`'
          enum:
          - legacy
          - enriched
          example: enriched
          type: string
        webhookIds:
          description: The webhook IDs.
          example:
          - '123'
          - '123'
          - '123'
          items:
            description: The ID of the webhook. This will appear in both Samsaras cloud dashboard and the API. This is system generated.
            example: '123'
            type: string
          type: array
      required:
      - webhookIds
      type: object
    PolygonResponseBody:
      description: Information about a polygon geofence. This field is only needed if the geofence is a polygon.
      properties:
        name:
          description: The name of the polygon.
          example: My Geofence Polygon
          type: string
        vertices:
          description: The vertices of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.
          items:
            $ref: '#/components/schemas/VertexResponseBody'
          type: array
      required:
      - name
      type: object
    AlertsPatchConfigurationsGatewayTimeoutErrorResponseBody:
      description: Gateway timeout
      properties:
        message:
          description: Message of error
          example: context deadline exceeded
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    SpeedTriggerDetailsObjectResponseBody:
      description: Details specific to Speed
      properties:
        minDurationMilliseconds:
          description: The number of milliseconds the trigger needs to stay active before alerting.
          example: 600000
          format: int64
          type: integer
        operation:
          description: 'How to evaluate the threshold.  Valid values: `GREATER`, `LESS`'
          enum:
          - GREATER
          - LESS
          example: GREATER
          type: string
        speedKilometersPerHour:
          description: The speed threshold value.
          example: 120
          format: int64
          type: integer
      required:
      - minDurationMilliseconds
      - operation
      - speedKilometersPerHour
      type: object
    AlertsPatchConfigurationsUnauthorizedErrorResponseBody:
      description: Unauthorized
      properties:
        message:
          description: Message of error
          example: Invalid token.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    EngineOnDetailsObjectResponseBody:
      description: Details specific to Engine On
      properties:
        minDurationMilliseconds:
          description: The number of milliseconds the trigger needs to stay active before alerting.
          example: 600000
          format: int64
          type: integer
      required:
      - minDurationMilliseconds
      type: object
    RouteStopEstimatedArrivalDetailsObjectRequestBody:
      description: Details specific to Route Stop Estimated Arrival
      properties:
        alertBeforeArrivalMilliseconds:
          description: Time threshold for when to send an alert. Sends an alert when the ETA is less than the threshold.
          example: 300000
          format: int64
          type: integer
        hasLiveShareLink:
          description: If true, will include a live sharing link in the alert. Defaults to false.
          example: true
          type: boolean
        isAlertOnRouteStopOnly:
          description: If true, will only alert if the vehicle is en-route to the stop. Defaults to false.
          example: true
          type: boolean
        location:
          $ref: '#/components/schemas/LocationObjectRequestBody'
      required:
      - alertBeforeArrivalMilliseconds
      - location
      type: object
    AlertsGetConfigurationsNotImplementedErrorResponseBody:
      description: Requested endpoint is not yet implemented
      properties:
        message:
          description: Message of error
          example: Not implemented.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    TinyAssetObjectRequestBody:
      description: Vehicle, trailer or other equipment to be tracked.
      properties:
        assetId:
          description: ID of the asset.
          example: '12443'
          type: string
        assetType:
          default: uncategorized
          description: 'The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized.  Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`'
          enum:
          - uncategorized
          - trailer
          - equipment
          - unpowered
          - vehicle
          example: trailer
          type: string
      required:
      - assetId
      - assetType
      type: object
    AlertsGetConfigurationsInternalServerErrorResponseBody:
      description: An internal server error occurred
      properties:
        message:
          description: Message of error
          example: Failed to execute GraphQL query.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    AlertsGetConfigurationsResponseBody:
      properties:
        data:
          description: List of alert configurations.
          items:
            $ref: '#/components/schemas/GetResponseWorkflowConfigurationObjectResponseBody'
          type: array
        pagination:
          $ref: '#/components/schemas/GoaPaginationResponseResponseBody'
      required:
      - data
      - pagination
      type: object
    ScheduledMaintenanceOdometerTriggerDetailsObjectResponseBody:
      description: Details specific to Scheduled Maintenance by Odometer
      properties:
        dueInMeters:
          description: Alert when vehicle odometer has this many meters left until maintenance is due.
          example: 5000
          format: int64
          type: integer
        scheduleId:
          description: The id of the maintenance schedule.
          example: '123'
          type: string
      required:
      - dueInMeters
      - scheduleId
      type: object
    DefLevelTriggerDetailsObjectRequestBody:
      description: Details specific to DEF Level
      properties:
        defLevelPercent:
          description: The DEF percentage threshold value.
          example: 100
          format: int64
          type: integer
        minDurationMilliseconds:
          description: The number of milliseconds the trigger needs to stay active before alerting.
          example: 600000
          format: int64
          type: integer
        operation:
          description: 'How to evaluate the threshold.  Valid values: `GREATER`, `LESS`'
          enum:
          - GREATER
          - LESS
          example: GREATER
          type: string
      required:
      - defLevelPercent
      - minDurationMilliseconds
      - operation
      type: object
    WorkflowTriggerObjectRequestBody:
      description: The trigger of an alert.
      properties:
        triggerParams:
          $ref: '#/components/schemas/TriggerParamsObjectRequestBody'
        triggerTypeId:
          description: 'The id of the trigger type. Reference the following list for the ids:


            Ambient Temperature = 1003

            DVIR Submitted for Asset = 5005

            Driver Recorded = 5027

            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

            '
          example: 1000
          format: int32
          type: integer
      required:
      - triggerTypeId
      type: object
    HarshEventTriggerDetailsObjectResponseBody:
      description: Details specific to Harsh Events
      properties:
        types:
          description: On which harsh events to trigger on.
          example:
          - haRollover
          - haRolloverProtectionEngineControlActivated
          items:
            description: 'The type of harsh event.  Valid values: `haAccel`, `haBraking`, `haCameraMisaligned`, `haCrash`, `haDistractedDriving`, `haDistractedDrivingCalibration`, `haDrinkPolicy`, `haDriverObstructionPolicy`, `haDrowsinessDetection`, `haEvent`, `haFalsePositive`, `haFoodPolicy`, `haInvalid`, `haLaneDeparture

# --- truncated at 32 KB (142 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/samsara/refs/heads/main/openapi/samsara-configurations-api-openapi.yml