Extended Unified Texecom Event Wrapper

A standardized schema for all events with detailed device information.

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

Properties

Name		Type
eventId		String
source		String
timestamp		String
eventType		String
version		String
correlationId		String
metadata		Object
payload	One of:
sourceDetails		Array

eventId

Description	A unique, immutable identifier for this specific event instance. This should be a UUID.
Type	String
Required	Yes
Format	uuid

source

Description	The origin of the event (e.g., 'PANEL_V4', 'PANEL_V5', 'SMARTCOM', 'SMARTCOMPRO', 'CLOUD', 'USER_SERVICE', 'NOTIFICATION_SERVICE').
Type	String
Required	Yes

timestamp

Description	The UTC timestamp when the event was generated at the source, in ISO 8601 format.
Type	String
Required	Yes
Format	date-time

eventType

Description	A standardized classification of the event's meaning.
Type	String
Required	Yes

version

Description	The version of this standardized event schema. Example: '1.0.0'
Type	String
Required	Yes
Pattern	^\d+\.\d+\.\d+$

correlationId

Description	A unique identifier for a sequence of related events.
Type	String
Required	Yes
Format	uuid

metadata

Description	Additional, non-essential data about the event, like routing information or device details.
Type	Object
Required	No

payload

Description	The original, raw event data from the source, wrapped within this unified schema. (https://texecom.atlassian.net/wiki/x/CoCWV)
Type	One of:
Required	Yes

payload.0

$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

payload.0.0

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

payload.0.0.sourceType

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

payload.0.0.data

Description	Raw panel event data
Type	Object

payload.0.0.data.eventCode

Description	Panel event code
Type	String

payload.0.0.data.area

Description	Area number
Type	Integer

payload.0.0.data.zone

Description	Zone number
Type	Integer

payload.0.0.data.user

Description	User number
Type	Integer

payload.0.1

Description	Payload from Smartcom/SmartcomPro devices
Type	Object

payload.0.1.sourceType

Description	The type of Smartcom device
Type	String
Enum	SMARTCOM SMARTCOMPRO

payload.0.1.data

Description	Smartcom event data
Type	Object

payload.0.2

Description	Payload from cloud services
Type	Object

payload.0.2.sourceType

Description	Cloud-generated event
Type	String
Const	CLOUD

payload.0.2.service

Description	Name of the cloud service generating the event
Type	String

payload.0.2.data

Description	Service-specific event data
Type	Object

payload.0.3

Description	Generic payload structure for other event sources
Type	Object

payload.0.3.sourceType

Description	The type of source generating the event
Type	String

payload.0.3.data

Description	Event-specific data
Type	Object

sourceDetails

Description	An array of structured objects for physical device-specific information.
Type	Array
Required	Yes

sourceDetails.guid

Description	A globally unique identifier for the physical device (e.g., panel_guid, smartcom_guid, cloud_id).
Type	String

sourceDetails.timestamp

Description	The UTC timestamp when the event was processed by this service, in ISO 8601 format.
Type	String
Format	date-time

sourceDetails.serialNumber

Description	The serial number of the device if applicable.
Type	String

sourceDetails.deviceType

Description	The type or model of the device (e.g., 'E048', 'smartcom', 'smartcompro').
Type	String

sourceDetails.firmwareVersion

Description	The firmware version of the deviceType if applicable.
Type	String

sourceDetails.country

Description	The ISO 3166 country code where the device is located.
Type	String

sourceDetails.language

Description	The ISO 639 language code configured on the device.
Type	String

Schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://schemas.texecom-prod.com/events/v1/unified-event-model.json",
    "title": "Extended Unified Texecom Event Wrapper",
    "description": "A standardized schema for all events with detailed device information.",
    "type": "object",
    "required": [
        "eventId",
        "source",
        "timestamp",
        "eventType",
        "version",
        "correlationId",
        "payload",
        "sourceDetails"
    ],
    "properties": {
        "eventId": {
            "description": "A unique, immutable identifier for this specific event instance. This should be a UUID.",
            "type": "string",
            "format": "uuid"
        },
        "source": {
            "description": "The origin of the event (e.g., 'PANEL_V4', 'PANEL_V5', 'SMARTCOM', 'SMARTCOMPRO', 'CLOUD', 'USER_SERVICE', 'NOTIFICATION_SERVICE').",
            "type": "string"
        },
        "timestamp": {
            "description": "The UTC timestamp when the event was generated at the source, in ISO 8601 format.",
            "type": "string",
            "format": "date-time"
        },
        "eventType": {
            "description": "A standardized classification of the event's meaning.",
            "type": "string"
        },
        "version": {
            "description": "The version of this standardized event schema. Example: '1.0.0'",
            "type": "string",
            "pattern": "^\\d+\\.\\d+\\.\\d+$"
        },
        "correlationId": {
            "description": "A unique identifier for a sequence of related events.",
            "type": "string",
            "format": "uuid"
        },
        "metadata": {
            "description": "Additional, non-essential data about the event, like routing information or device details.",
            "type": "object"
        },
        "payload": {
            "description": "The original, raw event data from the source, wrapped within this unified schema. (https://texecom.atlassian.net/wiki/x/CoCWV)",
            "oneOf": [
                {
                    "$ref": "payload-options.json"
                }
            ]
        },
        "sourceDetails": {
            "description": "An array of structured objects for physical device-specific information.",
            "type": "array",
            "items": {
                "type": "object",
                "required": [
                    "guid"
                ],
                "properties": {
                    "guid": {
                        "description": "A globally unique identifier for the physical device (e.g., panel_guid, smartcom_guid, cloud_id).",
                        "type": "string"
                    },
                    "timestamp": {
                        "description": "The UTC timestamp when the event was processed by this service, in ISO 8601 format.",
                        "type": "string",
                        "format": "date-time"
                    },
                    "serialNumber": {
                        "description": "The serial number of the device if applicable.",
                        "type": "string"
                    },
                    "deviceType": {
                        "description": "The type or model of the device (e.g., 'E048', 'smartcom', 'smartcompro').",
                        "type": "string"
                    },
                    "firmwareVersion": {
                        "description": "The firmware version of the deviceType if applicable.",
                        "type": "string"
                    },
                    "country": {
                        "description": "The ISO 3166 country code where the device is located.",
                        "type": "string"
                    },
                    "language": {
                        "description": "The ISO 639 language code configured on the device.",
                        "type": "string"
                    }
                }
            }
        }
    }
}

Texecom Event Schemas

Extended Unified Texecom Event Wrapper

Properties

eventId

source

timestamp

eventType

version

correlationId

metadata

payload

payload.0

payload.0.0

payload.0.0.sourceType

payload.0.0.data

payload.0.0.data.eventCode

payload.0.0.data.area

payload.0.0.data.zone

payload.0.0.data.user

payload.0.1

payload.0.1.sourceType

payload.0.1.data

payload.0.2

payload.0.2.sourceType

payload.0.2.service

payload.0.2.data

payload.0.3

payload.0.3.sourceType

payload.0.3.data

sourceDetails

sourceDetails.guid

sourceDetails.timestamp

sourceDetails.serialNumber

sourceDetails.deviceType

sourceDetails.firmwareVersion

sourceDetails.country

sourceDetails.language

Schema