EnSync Command Reference

This directory contains documentation for all EnSync commands. Each command is documented in its own page with detailed overview and command reference.

Available Commands

Connection Management

CONN - Initiate a connection to the EnSync system

Event Publishing

PUB - Publish an event to specified recipients

Event Subscription

SUB - Subscribe to specific event types
UNSUB - Unsubscribe from event types
PAUSE - Temporarily halt delivery of specific event types
CONTINUE - Resume delivery of previously paused event types

Event Actions

ACK - Acknowledge successful processing of an event
DEFER - Postpone processing of an event for a specified time period
DISCARD - Permanently remove an event from processing

Event Management

REPLAY - Request historical events from a specific point

Command Format

All EnSync commands follow a semicolon-delimited format:

COMMAND;PARAMETER1=value1;PARAMETER2=value2;...

Common Parameters

Parameter	Description	Used In
CLIENT_ID	ID of the client sending the command	All commands
EVENT_NAME	Type of event (follows domain/resource/action pattern)	Most commands
EVENT_IDEM	Unique ID of a specific event	DISCARD, DEFER, ACK

Response Format

All responses follow a consistent format:

Success

+PASS:RESULT;PARAM1=value1;PARAM2=value2;...

Error

-FAIL:ERROR_CODE;MESSAGE=error description

URL-Like Event Naming

Events in EnSync follow a URL-like hierarchical pattern:

domain/resource/action

For example:

user/profile/updated
order/payment/processed
system/maintenance/scheduled

This pattern enables hierarchical filtering and logical organization of events.

Last modified: 07 October 2025