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
payload	All of:	Object

---

payload

Type	All of:	Object
Required	Yes

Properties

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

payload.response

Type	String
Required	Yes

payload.message

Type	String
Required	Yes

payload.details

Type	Object
Required	No

payload.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

payload.0.protocol

Type	String

payload.0.arcId

Description	The unique id of the ARC
Type	String

payload.0.arcName

Description	The name of the ARC
Type	String

payload.0.arcEndPoint

Description	The configured endpoint of the ARC
Type	String

payload.0.monitorEventId

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

payload.0.monitorEventActionId

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

payload.0.monitorEventActionDetails

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

payload.0.monitorEventActionStatus

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

payload.0.monitorEventActionSentTime

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

payload.0.monitorEventActionReceivedTime

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

payload.0.monitorEventActionFlightTime

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

payload.0.monitorEventActionAckPending

Description	Indicates if the action has been acknowledged by the server
Type	Boolean

payload.0.monitorEventActionAcknowledged

Description	Timestamp that the user acknowledged the event (if applicable)
Type	Number

payload.0.lastUpdatedTime

Type	String
Format	date-time

payload.0.monitorEventActionSentTimeMs

Description	Timestamp that the message was sent to the server in milliseconds
Type	Number

payload.0.monitorEventActionReceivedTimeMs

Description	Timestamp that the message was received by the server in milliseconds
Type	Number

payload.0.monitorRuleId

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

payload.0.monitorRuleAction

Description	The action, see /api/phoenix/rules/actions in texecom-cloud repo
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": {
        "payload": {
            "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"
            ]
        }
    },
    "required": [
        "payload"
    ]
}