Skip to content
Gospl Wiki

Overview

Gospl — Platform / Notifications API 0.1.0-draft

Section titled “Gospl — Platform / Notifications API 0.1.0-draft”

Global notifications service: in-app inbox + email delivery. Features PUBLISH a notification (type + recipients + payload); the service resolves channels (per type defaults + user preferences), applies the template, and delivers. Authored by Claude. See specs/_platform/notifications.md. The /notifications/dispatch endpoint is the INTERNAL, service-to-service interface features call to publish; the rest are end-user (in-app inbox + preferences). Email delivery is a side-effect of dispatch, via Mailgun. DECIDED 2026-06-10: provider = Mailgun (pending confirmation); v1 has NO opt-out — all types mandatory, so the /preferences endpoints are POST-V1 (documented, not built for v1); digest timezone is per-tenant (admin/tenant-settings, default Europe/London).

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/notifications
GET
/notifications/unread-count
POST
/notifications/{notificationId}/read
POST
/notifications/read-all
GET
/notifications/preferences
PUT
/notifications/preferences
POST
/notifications/dispatch

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

Carries tenant + viewer. Inbox/preferences are caller-scoped; dispatch is a trusted service caller.

Security scheme type: http

Bearer format: JWT