Introductie

X-Guard is in staat “Alarm Events” door te sturen via HTTPS gebaseerde Webhooks. Deze koppeling biedt de mogelijkheid aan externe systemen om met behulp van een simpele HTTP-server een integratie te schrijven met een eigen platform.

Alle verzoeken verwachten een status HTTP-status 2xx als reactie. Bij een andere status dan zal de webhook opnieuw proberen het bericht af te leveren over een door ons te definiëren periode van tijd.

JSON payload

Het volgende document bevat een voorbeeld JSON-payload. We raden u aan om de om enkel de gemarkeerde lijnen te gebruiken tenzij anders overlegd. Let op: het is mogelijk dat er onaangekondigd nieuwe velden worden toegevoegd.

Code

{
  "operation": "create",
  "document": {
    "ack": {
      "ackedBy": {
        "_id": "bac6381a-284b-4d16-b83a-4c76c8615d37",
        "_ref": "User"
      },
      "ackedAt": null,
      "value": true,
      "comment": "acknowledged",
      "needed": true
    },
    "name": "Test Melding",
    "type": "test",
    "updatedAt": "2022-11-03T07:29:12.735Z",
    "asset": {
      "insideZones": [
        {
          "_ref": "Zone",
          "_id": "9afd9cd5-859b-4848-8339-127fdd10c39b"
        },
        {
          "_ref": "Zone",
          "_id": "b561d98b-59d9-4eb8-828a-be3bc429f0c9"
        },
        {
          "_id": "c5ae4fbc-e413-416f-999e-b52ad106daa8",
          "_ref": "Zone"
        }
      ],
      "customer": {
        "_ref": "Customer",
        "_id": "288d35ef-ff9a-4307-aeb8-7276fe4ab9c3"
      },
      "name": "Xander Guard",
      "lastObservationAt": "2022-11-03T07:25:49.541Z",
      "app": {
        "mode": "on"
      },
      "propertiesOwnership": "inherit",
      "updatedAt": "2022-11-03T07:29:12.735Z",
      "position": {
        "coordinates": [
          6.780647502832087,
          52.28510287489096
        ],
        "properties": {
          "altitudeAccuracy": 2,
          "accuracy": 8.3,
          "provider": "gps/zonal",
          "heading": 319.98,
          "speedAccuracy": 1.4040000000000001,
          "headingAccuracy": 9.35,
          "dateTime": "2022-11-03T07:25:48.267Z",
          "speed": 0,
          "address": {
            "countryCode": "NL",
            "floor": 0,
            "state": "Overijssel",
            "streetNumber": "50",
            "city": "Hengelo",
            "formattedAddress": "X-Guard B.V. - Welbergweg 50. 7556 PE, Hengelo OV",
            "streetName": "Welbergweg"
          },
          "altitude": 16.4
        },
        "type": "Point"
      },
      "assetGroups": [],
      "available": true,
      "properties": {
        "smsNumber": "+31600000000",
        "phoneNumber": "+31600000000",
        "locale": "en",
        "email": "info@x-guard.nl"
      },
      "_id": "214847df-661d-4b39-8c47-14ed9eafab12",
      "telluId": 84413545,
      "user": {
        "_ref": "User",
        "_id": "43a01f04-a0a2-445c-8223-9eb29f546ad4"
      },
      "createdAt": "2022-11-02T16:15:41.554Z",
      "invisibleResponder": false,
      "staticResponders": [],
      "share": {
        "type": "parents",
        "extra": []
      }
    },
    "position": {
      "properties": {
        "speed": 0,
        "heading": 319.98,
        "speedAccuracy": 1.4040000000000001,
        "headingAccuracy": 9.35,
        "dateTime": "2022-11-03T07:25:48.267Z",
        "altitude": 16.4,
        "altitudeAccuracy": 2,
        "accuracy": 8.3,
        "provider": "gps/zonal",
        "address": {
          "countryCode": "NL",
          "city": "Hengelo",
          "state": "Overijssel",
          "floor": 0,
          "streetNumber": "50",
          "streetName": "Welbergweg",
          "formattedAddress": "X-Guard B.V. Links - Welbergweg 50. 7556 PE, Hengelo OV"
        }
      },
      "coordinates": [
        6.780647502832087,
        52.28510287489096
      ],
      "type": "Point"
    },
    "alarmCenter": null,
    "createdAt": "2022-11-03T07:29:12.735Z",
    "customer": {
      "_ref": "Customer",
      "_id": "288d35ef-ff9a-4307-aeb8-7276fe4ab9c3"
    },
    "procedure": "1. De gebruiker heeft een systeem testmelding verstuurd waarvoor geen verdere actie nodig is. 2. Gebruiker dient commentaarveld in webportaal in te (laten) vullen.",
    "share": {
      "type": "parents",
      "extra": []
    },
    "meta": {},
    "_id": "723422a2-6b33-4639-a74a-2aee856564ec",
    "severity": "green"
  },
  "entity": "Alarm"
}