This repository hosts the technical reports for Solid Notifications.

These reports are incubated by the Solid Notifications Panel for inclusion in the Solid Technical Reports as part of the W3C Solid Community Group (CG). The reports are within the scope of the Notifications Panel Charter.

• Latest Published Version:
  • Solid Notifications Protocol
• Editors Draft:
  • Solid Notifications Protocol

The Solid Notification Protocol makes it possible to define notification channel types. In order to help with the discovery of notification channel types that can be used with the Solid Notifications Protocol, it is encouraged to register them for maximum global interoperability at Solid Technical Reports.

The notification channel types listed below are intended to be useful to application developers looking for existing channel types as well as to authors of new channel types.

• Editors Drafts:

  • EventSourceChannel2023
  • LDNChannel2023
  • StreamingHTTPChannel2023
  • WebhookChannel2023
  • WebSocketChannel2023
  • WebPushChannel2023

• Deprecated Editors Drafts:

  • WebSocketSubscription2021
  • StreamingHTTPSubscription2021
  • EventSourceSubscription2021
  • LinkedDataNotificationsSubscription2021
  • WebHookSubscription2021
  • WebPushSubscription2022

To add a new notification channel type to the list above, please create a PR including the name and the URL of the document describing the channel type.

Sequence diagrams use Mermaid as source syntax. Github workflow generates them automatically before deplying github pages. Any file ending with .mmd will be rendered into file ending with .mmd.svg. For exmple source-flow.mmd results in source-flow.mmd.svg which can be referenced from the spec.

To preview diagrams locally following tools are available:

• Mermaid Live Editor
• Docker image
• mermaid-cli
• code editor extensions

All *.mmd.svg files are ignored by git so they won't be commited to the repository.