NotificationsProviderService

This service implements the Solid Notifications Protocol. It allows clients to listen to any resource on a Pod, with a webhook or websocket channel.

We support the same notification format as the Community Solid Server. Additionally, we allow clients to listen to ActivityStreams collections.

Usage

const { NotificationsProviderService } = require('@semapps/solid');

module.exports = {
  mixins: [NotificationsProviderService],
  settings: {
    baseUrl: 'http://localhost:3000/',
    queueServiceUrl: 'http://localhost:6379/0',
    channels: {
      webhook: true, // Default value
      websocket: true // Default value
    }
  }
};

Service settings

Property	Type	Default	Description
baseUrl	String	required	Base URL of the server
queueServiceUrl	String	required	Redis connection string used to queue jobs
channels.webhook	Boolean	true	If true, allow clients to listen with webhooks
channels.websocket	Boolean	true	If true, allow clients to listen with websockets