Skip to content

Document real-time WebSocket events via Pusher - #39

Open
EtayM wants to merge 7 commits into
enjin:masterfrom
EtayM:docs/pusher-events
Open

Document real-time WebSocket events via Pusher#39
EtayM wants to merge 7 commits into
enjin:masterfrom
EtayM:docs/pusher-events

Conversation

@EtayM

@EtayM EtayM commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Enjin Platform events are now pushed in real time over Pusher-protocol WebSockets. This replaces the "coming soon" stub on the WebSocket Events page with the full reference:

  • Beginner-friendly intro (polling vs push, what Pusher is, no Pusher account needed) and a step-by-step "how it works".
  • Quick start: a complete runnable pusher-js listener.
  • AuthenticatePusherSocket reference (signature verified against the live API) and the private-channel handshake.
  • Raw-WebSocket walkthrough for stacks without a first-party Pusher library.
  • Catalog of the six platform events with payload examples and follow-up-query guidance.

Also updates Working with Events and the other pages that told readers event streaming was planned-but-unavailable to point at the new reference instead of (or alongside) polling.

The whole flow was verified live end-to-end (connect → authenticate → subscribe → ManagedWalletRequested/ManagedWalletCreated received with the documented payloads).

Stacked on #37 — please review/merge #37 first; this PR's own changes are the last two commits (Document real-time WebSocket events via Pusher and the follow-up sweep). It'll be rebased after #37 lands so the diff reduces to just that.

EtayM and others added 7 commits July 14, 2026 21:17
Events shipped on the v3 API: Transaction now exposes an extrinsic
object (id, hash, success, signer, block, events) instead of the
removed extrinsicHash field.

- Rewrite Working with Events: replace the coming-soon callout and
  Subscan workflow with the GetTransaction -> extrinsic.events flow,
  Event field reference, and a verified create-collection example.
- Update GetTransaction/GetTransactions/GetBlock/GetExtrinsic
  reference: extrinsic { hash } selections, events sub-fields, drop
  the three outage warnings (verified fixed), Block.validator is now
  a plain hex string, GetBlocks requires ids or hashes.
- Swap stale extrinsicHash selections in getting-started and
  mutation examples for extrinsic { hash }.
- WebSocket Events page: point the interim workflow at the API
  events flow instead of Subscan (streaming itself still planned).

All shapes and payloads verified against the live canary network.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Brad Bayliss <brad@bayliss.co.uk>
Co-authored-by: Brad Bayliss <brad@bayliss.co.uk>
Co-authored-by: Brad Bayliss <brad@bayliss.co.uk>
Resolve the working-with-events conflict by keeping this branch's
rewrite of the Platform UI paragraph, updated to the standardized
platform.enjin.io hostname, and point the rest of the page's snippets
at platform.enjin.io as well.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The platform now pushes events over WebSocket using the Pusher
protocol. Replace the coming-soon websocket-events stub with the
full reference: connection details, the AuthenticatePusherSocket
private-channel handshake, subscribing with pusher-js and over a raw
WebSocket, and the catalog of platform events with payload examples.

Update working-with-events and the other pages that told readers
event streaming was planned-but-unavailable to point at the new
reference instead of (or alongside) polling.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The sending-wallet-requests and SDK getting-started pages merged
after the initial sweep and still told readers push notifications
were unavailable. Offer the WalletLinked / TransactionStateChanged
subscriptions alongside polling, and note that wallet disconnection
has no event and still requires a GetLinkedWallet check.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@EtayM
EtayM force-pushed the docs/pusher-events branch from 372ee3c to 3bedd3a Compare August 24, 2026 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant