Event Payload Options

Schema defining the possible payload structures for different event sources

$id	https://schemas.texecom-prod.com/events/v1/payload-options.json
$schema	http://json-schema.org/draft-07/schema#

---

$id	https://schemas.texecom-prod.com/events/v1/payload-options.json
Title	Event Payload Options
Description	Schema defining the possible payload structures for different event sources
Type	One of:	Object
		Object
		Object
		Object

0

Description	Payload from panel devices (V4/V5)
Type	Object

Properties

Name		Type
sourceType		String
data		Object

0.sourceType

Description	The type of panel generating the event
Type	String
Enum	PANEL_V4 PANEL_V5

0.data

Description	Raw panel event data
Type	Object

0.data.eventCode

Description	Panel event code
Type	String

0.data.area

Description	Area number
Type	Integer

0.data.zone

Description	Zone number
Type	Integer

0.data.user

Description	User number
Type	Integer

1

Description	Payload from Smartcom/SmartcomPro devices
Type	Object

Properties

Name		Type
sourceType		String
data		Object

1.sourceType

Description	The type of Smartcom device
Type	String
Enum	SMARTCOM SMARTCOMPRO

1.data

Description	Smartcom event data
Type	Object

2

Description	Payload from cloud services
Type	Object

Properties

Name		Type
sourceType		String=CLOUD
service		String
data		Object

2.sourceType

Description	Cloud-generated event
Type	String
Const	CLOUD

2.service

Description	Name of the cloud service generating the event
Type	String

2.data

Description	Service-specific event data
Type	Object

3

Description	Generic payload structure for other event sources
Type	Object

Properties

Name		Type
sourceType		String
data		Object

3.sourceType

Description	The type of source generating the event
Type	String

3.data

Description	Event-specific data
Type	Object

---

Schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://schemas.texecom-prod.com/events/v1/payload-options.json",
    "title": "Event Payload Options",
    "description": "Schema defining the possible payload structures for different event sources",
    "oneOf": [
        {
            "$ref": "#/definitions/PanelPayload"
        },
        {
            "$ref": "#/definitions/SmartcomPayload"
        },
        {
            "$ref": "#/definitions/CloudPayload"
        },
        {
            "$ref": "#/definitions/GenericPayload"
        }
    ],
    "definitions": {
        "PanelPayload": {
            "type": "object",
            "description": "Payload from panel devices (V4/V5)",
            "required": [
                "sourceType",
                "data"
            ],
            "properties": {
                "sourceType": {
                    "type": "string",
                    "enum": [
                        "PANEL_V4",
                        "PANEL_V5"
                    ],
                    "description": "The type of panel generating the event"
                },
                "data": {
                    "type": "object",
                    "description": "Raw panel event data",
                    "properties": {
                        "eventCode": {
                            "type": "string",
                            "description": "Panel event code"
                        },
                        "area": {
                            "type": "integer",
                            "description": "Area number"
                        },
                        "zone": {
                            "type": "integer",
                            "description": "Zone number"
                        },
                        "user": {
                            "type": "integer",
                            "description": "User number"
                        }
                    }
                }
            }
        },
        "SmartcomPayload": {
            "type": "object",
            "description": "Payload from Smartcom/SmartcomPro devices",
            "required": [
                "sourceType",
                "data"
            ],
            "properties": {
                "sourceType": {
                    "type": "string",
                    "enum": [
                        "SMARTCOM",
                        "SMARTCOMPRO"
                    ],
                    "description": "The type of Smartcom device"
                },
                "data": {
                    "type": "object",
                    "description": "Smartcom event data"
                }
            }
        },
        "CloudPayload": {
            "type": "object",
            "description": "Payload from cloud services",
            "required": [
                "sourceType",
                "service",
                "data"
            ],
            "properties": {
                "sourceType": {
                    "type": "string",
                    "const": "CLOUD",
                    "description": "Cloud-generated event"
                },
                "service": {
                    "type": "string",
                    "description": "Name of the cloud service generating the event"
                },
                "data": {
                    "type": "object",
                    "description": "Service-specific event data"
                }
            }
        },
        "GenericPayload": {
            "type": "object",
            "description": "Generic payload structure for other event sources",
            "required": [
                "sourceType"
            ],
            "properties": {
                "sourceType": {
                    "type": "string",
                    "description": "The type of source generating the event"
                },
                "data": {
                    "type": "object",
                    "description": "Event-specific data"
                }
            }
        }
    }
}