Detailed technical specification (journal based architecture)

See slides at https://hedgedoc.softwareheritage.org/4TWzIN1qRgiCN8Yl540BAQ#.

It has been decided to rely on an open source webhooks framework to manage event types, user subscriptions, messages sending and archiving. The current candidates are Svix and Hook0.

Below is the checklist of related sub-tasks:

• Evaluate open source webhooks frameworks and pick the best one
• Define an interface to register webhook event types
• Define an interface to subscribe a user to an event
• Define an interface to send webhook messages
• Define a CLI to ease webhooks administration
• Add Web API endpoints for users to subscribe to events
• Create a Web UI for users to subscribe to events

changed milestone to %Webhook-based notification for long-running user tasks [Roadmap - Share]

added activity::Design roadmap_import labels

assigned to @anlambert

changed title from Detailled technical specification (journal based architecture) to Detailed technical specification (journal based architecture)

changed the description

marked this issue as related to swh/devel/swh-webhooks#1 (closed)

marked the checklist item Define an interface to subscribe a user to an event as completed

marked the checklist item Define an interface to subscribe a user to an event as incomplete

marked the checklist item Evaluate open source webhooks frameworks and pick the best one as completed

marked the checklist item Define an interface to register webhook event types as completed

marked the checklist item Define a CLI to ease webhooks administration as completed