Texecom Test ARC Received Event Type

Event type for Texecom Test ARC received payload.

$id	https://schemas.texecom-prod.com/v2/events/event-type/arc/json/received/v1.0.0.json
$schema	http://json-schema.org/draft-07/schema

Properties

Name		Type
receivedPayload	All of:	Object

---

receivedPayload

Type	All of:	Object
Required	No

Properties

Name		Type
response		String
message		String
details		Object
All of:		Object

receivedPayload.response

Type	String
Required	Yes

receivedPayload.message

Type	String
Required	Yes

receivedPayload.details

Type	Object
Required	No

receivedPayload.0

$id	https://schemas.texecom-prod.com/v2/events/event-type/arc/common/received/v1.0.0.json
Title	Common Properties for ARC response events
Description	Common properties shared across multiple ARC received event types.
Type	Object

receivedPayload.0.panelId

Description	The id of the site that triggered this event
Type	Number

receivedPayload.0.arcId

Description	The unique id of the ARC
Type	String

receivedPayload.0.arcName

Description	The name of the ARC
Type	String

receivedPayload.0.arcEndpoint

Description	The configured endpoint of the ARC
Type	String

receivedPayload.0.monitorEventId

Description	The id of the event that triggered this action
Type	Number

receivedPayload.0.monitorEventActionId

Description	The id of the action that triggered this event
Type	Number

receivedPayload.0.details

Description	Details of what was done, depends on the action
Type	String

receivedPayload.0.sentPayload

Description	The payload content sent to the ARC
Type	String

receivedPayload.0.error

Description	Error message (if there was an error)
Type	String

receivedPayload.0.status

Description	Indicates the action status 0=success, 1 and above is an error code
Type	Number

receivedPayload.0.sentTime

Description	Timestamp that the message was sent to the server
Type	String
Format	date-time

receivedPayload.0.receivedTime

Description	Timestamp that the message was received by the server
Type	String
Format	date-time

receivedPayload.0.flightTime

Description	The message flight time in milliseconds (essentially received timestamp in millseconds minus sent timestamp in milliseconds)
Type	Number

receivedPayload.0.monitorRuleId

Description	The id of the rule that triggered this event
Type	Number

---

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/event-type/arc/json/received/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Texecom Test ARC Received Event Type",
    "description": "Event type for Texecom Test ARC received payload.",
    "type": "object",
    "properties": {
        "receivedPayload": {
            "type": "object",
            "properties": {
                "response": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "details": {
                    "type": "object",
                    "additionalProperties": true
                }
            },
            "allOf": [
                {
                    "$ref": "../../common/received/v1.0.0.json"
                }
            ],
            "required": [
                "response",
                "message"
            ]
        }
    }
}