This documentation will describe the Heartbeat endpoint. This endpoint allows users to perform the necessary call that notifies the driver that the source of alarm events is healthy. Users must call this endpoint every 20 seconds.

Example request

curl --location 'https://rx-test.securemcloud.com/rx/demo:driver1/hb' \
--header 'Authorization: Bearer 6r7R5mSCdWpVMQCzj72TcZHpd5bkLvDE' 

Example response

    "status_code": 200,
    "status": "success"

Possible error messages

No access to this receiver

The HTTP_BEARER_TOKEN provided doesn’t have permission to send a heartbeat to the defined SOURCE:DESTINATON. Verify the information is correct.

    "status_code": 401,
    "error_code": "HB-1",
    "status": "error",
    "message": "no access to this receiver"