pusher-server-api-webhook-channels
Service icon

Pusher Server API Webhook (Channels)

version 1.0.0 (Compatible with OutSystems 11)
Uploaded
 on 14 December 2023
 by 
LINKIT
0.0
 (0 ratings)
pusher-server-api-webhook-channels

Pusher Server API Webhook (Channels)

Documentation
1.0.0

Events

Channel existence events

Notify your application when channels become occupied or vacated.

For example, this allows you to publish events to a channel only when somebody is actually subscribed.

Cache channels events

Notify your application when a client subscribes to a channel with no cached message

Presence events

Notify your application whenever a user subscribes to or unsubscribes from a Presence channel.

For example, this allows you to synchronise channel presence state on your server as well as all your application clients.

Client events

Notify your application whenever a client event is sent.

Subscription count events

Notify your application whenever the subscription count of a channel changes. Provides the number of connections that are currently subscribed to the channel.

To enable the Subscription Count feature, navigate to the Pusher Channels dashboard for your application > App Settings and switch the toggle on. Once activated, the event will be broadcast on all channel types except Presence channels.

Access Webhook Events

The Pusher Server API Webhook (Channels) forge component needs to be installed to enable this functionality. With the forge component installed review that the "Light process execution" under "Operation" is set to true for the PusherChannelsWebhook_API module.

The PusherWebhookEvent entity has "Expose Process Events" set to true.

Accessing and processing events in your application can be performed automatically by creating a process in your module and simply setting the Launch On process property with the CreateEntity action.

When a process is automatically launched as a result of a Create entity action, logic to process the associated event can be extended using the OutSystems BPT.

PusherWebhookEvent and WebhookQueue maintenance

To prevent the accumulation of data over time, some timers will trim records from the PusherWebhookEvent, WebhookQueue and WebhookQueueContent entities.

The timers are in the PusherChannelsWebhook_API module that can be configured and scheduled per tenant to run.

The "Timer_TrimPusherWebhookEvent" timer is set to run once per day. The PusherWebhookEvent_EnableTrim and PusherWebhookEvent_RetentionInMinutes site properties control and configure the timer.

The "Timer_TrimWebhookQueue" timer is set to run every hour. The TrimWebhookQueue_EnableTrim site property controls the timer.

The "Timer_TrimWebhookQueueErrors" timer is set to run every hour. The TrimWebhookQueueErrors_EnableTrim site property controls the timer.