Skip to main content

WebSocket Events

Coming soon

Real-time event streaming is planned for the Enjin Platform but is not yet available. The exact API shape (subscription endpoint, channel structure, event payload) hasn't been finalized — this page will be filled in with the full reference once support ships.

When it ships, this page will document how to subscribe to real-time events emitted by the platform. Typical use cases include:

  • Reading IDs that the chain assigns at execution time — for example, picking up the new listing_id the moment a createListing transaction is finalized, or the new collection_id after a createCollection, without having to poll or look up Subscan.
  • Reacting to incoming token activity in real time — unlocking an in-game item the instant a transfer to the player's wallet finalizes, or refreshing a marketplace UI the moment a bid lands on an active auction.
  • Driving transaction state UI without polling — flipping a "Pending → Broadcast → Finalized" indicator off the platform's own state changes.

Until then​

  • Transaction state — poll GetTransaction(uuid:) until state becomes FINALIZED. The transaction's extrinsicHash is also exposed once it's broadcast.
  • On-chain events emitted by a transaction (the new collection ID after createCollection, the listing ID after createListing, etc.) — open the transaction on Subscan via its extrinsicHash and read the Events tab. See Working with Events for the full flow.

An events field will also be added to the Transaction type so on-chain event payloads can be read alongside the rest of the transaction. Once it ships, this page and the GetTransaction reference will be updated with the full event shape and response examples.