Webhooks

Creación de webhooks

Puede crear webhooks para que se le notifiquen las alertas de su cuenta Samsara. Esto es especialmente útil si quiere crear integraciones que transmitan un incidente de alerta especial, como cuando un vehículo llega a una ubicación determinada o si la temperatura del contenedor supera una cantidad determinada. Para obtener una lista completa de todas las alertas incluidas en Samsara, consulte este Página de resumen de alertas.

Los webhooks se pueden ver y crear a través del panel de Samsara. Acceda al icono de engranaje y haga clic en Webhooks. Haga clic en (+ Añadir webhook) para crear un webhook. Cada webhook debe contar con un nombre y una ruta a una URL https.

Una vez creado un webhook, se pueden configurar alertas individuales para que se envíen a una URL de webhook determinada. Para ello, acceda al icono de campana para crear una alerta nueva o configurar una alerta existente. 

Nota: aún no está disponible para la alerta DVIR no seguro.

Responder a incidentes de webhook

Debe confirmar la recepción de una solicitud de webhook con un código de respuesta 2xx. Si no se reconoce un webhook, Samsara seguirá reintentando en un modo exponencial de retroceso. 

Cargas útiles

Los webhooks de Samsara devuelven respuestas codificadas mediante JSON.

Ejemplo de cargas útiles

Consulte aquí para obtener información detallada sobre los atributos de la carga útil.

Alerta de perímetro (geofence)

{
  "eventId": "f4bfadf8-ac64-4436-9bfa-42c0f37d3a33",
  "eventMs": 1486029722000,
  "eventType": "Alert",
  "event": {
    "alertConditionDescription": "Vehicle is inside geofence",
    "alertConditionId": "DeviceLocationInsideGeofence",
    "alertEventUrl": "https://cloud.samsara.com/groups/4185/alerts/incidents/v2/1000/1/222/1483228800000",
    "details": "'Truck ABC' is 5 miles away from Acme Bread",
    "device": {
      "id": 2000,
      "name": "Truck ABC",
      "serial": "ABC123",
      "vin": "1M8GDM9AXKP042788"
    },
    "orgId": 4000,
    "resolved": false,
    "startMs": 1486029722000,
    "summary": "'Truck ABC' is inside Acme Bread geofence"
  }
}

Alerta de batería de vehículo: 

{
  "eventId": "746bd028-44df-4df4-9dc8-c4c887d9bff0",
  "eventMs": 1587151453491,
  "eventType": "Alert",
  "event": {
    "alertEventUrl": "https://cloud.samsara.com/o/00001/alerts/incidents/v2/30750/1/212014918214835/1587151393206/link?dl=eyJkZWVwTGlua1R5cGUiOiJBbGVydENvbmRpdGlvblR5cGVfQmF0dGVyeVZvbHRhZ2VCZWxvdyIsImdyb3VwSWQiOjE2NzM3fQ==",
    "alertConditionDescription": "Battery voltage below",
    "alertConditionId": "BatteryVoltageBelow",
    "details": "'Truck ABC' vehicle battery level has fallen below 15.000 V for more than 0 minutes. It is currently 12.052 V.",
    "device": {
      "id": 212014918214835,
      "name": "Truck ABC",
      "serial": "ABC123",
      "vin": "2JEA93JALLAL211A"
    },
    "orgId": 123,
    "resolved": false,
    "startMs": 1587151393206,
    "summary": "'Truck ABC' vehicle battery level has fallen below 15.000 V for more than 0 minutes. It is currently 12.052 V."
  }
}

Alerta de velocidad:

{
  "eventId": "f4bfadf8-ac64-4436-9bfa-42c0f37d3a33",
  "eventMs": 1486029722000,
  "eventType": "Alert",
  "event": {
    "alertConditionDescription": "Vehicle speed",
    "alertConditionId": "DeviceSpeedAbove",
    "alertEventUrl": "https://cloud.samsara.com/groups/4185/alerts/incidents/v2/1000/1/222/1483228800000",
    "details": "'Truck ABC' was speeding 65MPH in a 50MPH speed limit zone",
    "driver": {
      "id": 5000,
      "name": "Speed Demon"
    },
    "orgId": 4000,
    "resolved": false,
    "startMs": 1486029722000,
    "summary": "'Truck ABC' was speeding 65MPH in a 50MPH speed limit zone"
  }
}

Alerta de llegada a parada de ruta:

{
  "eventId": "f4bfadf8-ac64-4436-9bfa-42c0f37d3a33",
  "eventMs": 1486029722000,
  "eventType": "Alert",
  "event": {
    "alertConditionDescription": "Dispatch Route ETA threshold",
    "alertConditionId": "DispatchRouteETAThreshold",
    "alertEventUrl": "https://cloud.samsara.com/groups/4185/alerts/incidents/v2/1000/1/222/1483228800000",
    "details": "'Truck ABC' is 15 minutes away from ACME Bread",
    "route": {
      "id": 6000,
      "name": "Bread Route"
    },
    "orgId": 4000,
    "resolved": false,
    "startMs": 1486029722000,
    "summary": "'Truck ABC' is 15 minutes away from ACME Bread"
  }
}

Alerta de temperatura:

{
  "eventId": "f4bfadf8-ac64-4436-9bfa-42c0f37d3a33",
  "eventMs": 1486029722000,
  "eventType": "Alert",
  "event": {
    "alertConditionDescription": "Ambient temperature is above",
    "alertConditionId": "TemperatureAbove",
    "alertEventUrl": "https://cloud.samsara.com/groups/4185/alerts/incidents/v2/1000/1/222/1483228800000",
    "details": "'Temperature probe' has been above 40 degrees fahrenheit for 15 minutes",
    "sensor": {
      "id": 7000,
      "name": "Temperature probe",
      "serial": "ABC123"
    },
    "orgId": 4000,
    "resolved": false,
    "startMs": 1486029722000,
    "summary": "'Temperature probe' has been above 40 degrees fahrenheit for 15 minutes"
  }
}

Atributos

Tabla de condiciones de alerta

Verificar firmas de webhook

Samsara utiliza firmas de webhook para indicar que ha enviado una carga útil. Las cargas útiles de los webhook se firman mediante cifrado HMAC-SHA256, que se puede encontrar en el encabezado "X-Samsara-Signature".

Para verificar que la carga útil ha sido enviada por nosotros, puede calcular la firma a partir de la clave secreta de webhook y verificar que coincide con la firma en el encabezado:

A continuación, se muestra un pseudocódigo basado en Python para verificar que la firma calculada coincide con la del encabezado del cuerpo de la carga útil.

import hashlib
import hmac
import base64
import codecs

timestamp = header["X-Samsara-Timestamp"]
plaintext_signature = "v1:%s:%s" % (timestamp, body)
secret = base64.b64decode(<YOUR_SECRET_KEY>)
signature = "v1=" + codecs.encode(hmac.new(secret, plaintext_signature, digestmod=hashlib.sha256).digest(), 'hex_codec')
assert(signature==header["X-Samsara-Signature"])