business-events

Find it fast

sed -n '<from>,<to>p' SKILL.md one section rather than reading the file; ./mxcli syntax <topic> answers how do I write this for a fraction of either.

lines	section
24-31	When to Use This Skill
32-101	Commands
102-117	Message Definition Syntax
118-125	Service Properties
126-132	Operations
133-169	Publishing Events from Microflows
170-182	Checklist

Business Events

When to Use This Skill

Use this skill when the user wants to:

• Define event-driven APIs using Kafka/message brokers
• Create business event services that publish events
• View or describe existing business event services
• Set up publish/subscribe message channels

Commands

View Business Events

-- List all business event service documents
list business event services;

-- Filter by module
list business event services in MyModule;

-- List all business event client documents (future)
list business event clients;

-- List individual messages across all services
list business events;

-- Filter messages by module
list business events in MyModule;

-- Full MDL description (round-trippable)
describe business event service Module.ServiceName;

Create a Business Event Service

mdl 1;
create business event service Module.CustomerEventsApi
(
  ServiceName: 'CustomerEventsApi',
  EventNamePrefix: 'com.example'
)
{
  message CustomerChangedEvent (CustomerId: long) publish
    entity Module.PBE_CustomerChangedEvent;
  message AddressChangedEvent (AddressId: long) publish
    entity Module.PBE_AddressChangedEvent;
};

Create or Modify (Idempotent Update — Preferred)

Preserves the existing UUID so other documents that reference this service remain valid. OR REPLACE is accepted as a synonym. Each message keeps its stored channel — the channel name is the Kafka topic subscribers listen on — matched by message name, so a re-run of an unchanged script reports Unchanged; only a new message gets a new (random) channel name. Renaming a message is a new channel. There is no MDL property to state a channel name, so two apps defining "the same" service get different topics.