CreateEventRequest

  • startedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • type
    Type: integer · EventTypeenum
    required

    Integer numbers.

    values
    • 1

      InputPowerDisconnected

    • 2

      InputVoltageLow

    • 3

      BatteryLow

    • 4

      Jammed

    • 5

      MovementStarted

  • channel
    Type: object · AlertRuleChannel nullable

    The channel to notify the recipient through. Used to bypass the alert rule engine.

    • type
      Type: integer · ChannelTypeenum
      required

      Integer numbers.

      values
      • 1

        Call

      • 2

        Sms

      • 3

        Telegram

      • 4

        Email

    • call
      Type: object · CallChannelOptions nullable
    • email
      Type: object · EmailChannelOptions nullable
    • sms
      Type: object · SmsChannelOptions nullable
    • telegram
      Type: object · TelegramChannelOptions nullable
  • location
    Type: object · Location nullable
    • address
      Type: object · Address nullable
    • name
      Type: null | string

      The well-known name of the location, or the name of a geofence that was entered or exited.

  • recipient
    Type: object · Recipient nullable

    The recipient to notify. Used to bypass the alert rule engine.

    • culture
      required
    • phoneNumber
      Type: string
      required

      The phone number of the recipient in E.164 format (e.g. +1234567890).

    • timeZone
      required
    • description
      Type: null | string
  • telemetry
    Type: object · Telemetry nullable
    • adBlueLevel
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Unit: percentage 0.0-1.0

    • altitude
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Unit: m

    • batteryLevel
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Unit: percentage 0.0-1.0

    • batteryVoltage
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Unit: V

    • driverIds
      Type: array string[] | null
    • fuelLevel
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Unit: percentage 0.0-1.0

    • heading
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: uint32

      Unit: degrees 0-360

    • inputVoltage
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Unit: V

    • isAlarmTriggered
      Type: null | boolean
    • isDriverAuthenticated
      Type: null | boolean
    • isIgnitionOn
      Type: null | boolean
    • isLockdownEnabled
      Type: null | boolean
    • isMoving
      Type: null | boolean
    • latitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
    • longitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
    • pressure
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Unit: kPa

    • speed
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: uint32

      Unit: km/h

    • temperature
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Unit: deg C