JSON Webhook integration
    • 11 Aug 2023
    • 1 Minute to read
    • Dark
      Light
    • PDF

    JSON Webhook integration

    • Dark
      Light
    • PDF

    Article summary

    JSON format integration is implemented by using standard JSON encoder. The data is meant to be inserted to the body of an HTTP POST message.The format uses the SIA event codes to specifiy event types. 


    Information necessary to set up the integration:

    • Server address and port
    • HTTP endpoint path
    • Default account identification and device info
      • Site identification
      • (optional) Area value (variable length 0-3)
      • (optional) Zone value (variable length 0-3)


    Description field format:Json:#<site><|area><-zone>

    # Full account identification including site ID in addition to account and zone:

     Json:#1234567890|123-123

    # Account identification with site ID '9999' and zone ID '1':

    Json:#9999-1

    # only site identification specified:

    Json:#9999

    Supported event types:

    Reconeyez
    SIA event

    SystemStarted
    -
    SystemStopped
    -

    PersonDetected
    BA Burglary Alarm

    VehicleDetected
    BA Burglary Alarm

    MovementDetected
    BA Burglary Alarm

    RoutineCheck
    RP Automatic Test

    Tamper
    TA Tamper Alarm

    Armed
    CL Closing Report

    Disarmed
    OP Opening Report

    ConnectionLost
    YC Communication Fail

    DeviceConnected
    YK Communication Restore

    BatteryLow
    XT TX Battery Trouble

    BatteryRestored
    XR TX Battery Restoral

    CriticalBatteryShutdown
    YT System Battery Trouble



    Was this article helpful?