Skip to Content

PusherApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
pusherAuthPOST /pusher/authAuthenticate private Pusher channel
pusherAuthPresencePOST /pusher/auth-presenceAuthenticate presence Pusher channel
pusherWebhooksPOST /pusher/webhooksHandle Pusher webhooks

pusherAuth

PusherAuthResponse pusherAuth(PusherAuthRequest)

Authenticate private Pusher channel

Generates an authentication signature for a private Pusher channel, allowing the client to establish a secure WebSocket connection. This endpoint validates the user’s authentication and returns a signed token that proves the user’s authorization to subscribe to the channel.

Parameters

NameTypeDescriptionNotes
PusherAuthRequestPusherAuthRequestPusher authentication request containing socket ID and channel name

Return type

PusherAuthResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

pusherAuthPresence

PusherAuthPresenceResponse pusherAuthPresence(PusherAuthRequest)

Authenticate presence Pusher channel

Generates an authentication signature for a presence Pusher channel, enabling real-time presence tracking. This endpoint returns both an auth signature and channel_data containing user information, allowing other channel subscribers to see who is currently online.

Parameters

NameTypeDescriptionNotes
PusherAuthRequestPusherAuthRequestPusher authentication request containing socket ID and presence channel name

Return type

PusherAuthPresenceResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

pusherWebhooks

MessageResponse pusherWebhooks()

Handle Pusher webhooks

Receives webhook events from Pusher to track user presence. Handles MemberAdded and MemberRemoved events to update the is_online status of users in real-time.

Parameters

This endpoint does not need any parameter.

Return type

MessageResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8