Subscribe to Events

Subscriptions act as filters for events addressed to you. Events sent to your Client ID but outside your subscriptions will queue based on your plan’s retention period (up to 30 days). Subscribe later to automatically receive queued events.

Usage

Node.js
Python

const subscription = await client.subscribe("order/*", {
  autoAck: false
});

subscription.on(async (event) => {
  console.log("Received:", event.payload);
  await subscription.ack(event.idem, event.block);
});

subscription = await client.subscribe("order/*", {
  "auto_ack": False
})

async def handle_event(event):
    print(f"Received: {event.payload}")
    await subscription.ack(event.idem, event.block)

subscription.on(handle_event)

Parameters

Parameter	Type	Required	Description
`eventName`	`string`	Yes	Event path (supports wildcards: `order/*`)
`options`	`object`	No	Subscription options

Options

Option	Type	Default	Description
`autoAck`	`boolean`	`true`	Auto-acknowledge events
`appSecretKey`	`string`	`null`	Custom decryption key

Event Structure

{
  idem: "unique-event-id",
  block: "block-id",
  eventName: "order/created",
  payload: { /* your data */ },
  timestamp: 1634567890123,
  sender: "sender's appId",
  metadata: {
    $internal: {
      // EnSync internal metadata
      // e.g., message_size, replay_info, etc.
    }
  }
}

Publish a Message Acknowledging Messages

Home:

Guides

What Are:

How Does EnSync:

Compare EnSync:

How To:

Client SDKs

Legal

Usage

Parameters

Options

Event Structure

​Usage

​Parameters

​Options

​Event Structure

Usage

Parameters

Options

Event Structure