Real-time events

Receive changes over authenticated WebSocket channels. OAuth grants channel access; connection details are supplied separately for each tenant environment.

Connection

Configure the WebSocket client with the supplied application key, host, port, and TLS scheme. Include Authorization: Bearer {access_token} in private-channel authorization requests. Required scope: realtime:connect.

POST/broadcasting/auth

Authorize a channel

Send the client-generated socket_id and requested channel_name as form data. The endpoint validates the OAuth token, realtime:connect scope, tenant membership, and channel authorization policy, then returns the channel authorization signature.

curl -X POST https://{tenant}.alution.cloud/broadcasting/auth \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "socket_id=123.456" \
  --data-urlencode "channel_name=private-tenants.42.tickets"

Channels and event names

Private channels are tenant-prefixed. Available families include private-tenants.{tenantId}.tickets, private-tenants.{tenantId}.contacts, private-tenants.{tenantId}.appointments, and corresponding record-specific channels.

Event names use kebab case, for example ticket-created-event, ticket-updated-event, and ticket-deleted-event.