Guide
Notifications
In-app notifications delivered to a signed-in user, with per-type preferences to control which ones they receive. Every endpoint on this page lives under https://api.swiftgoma.com/api/v1/notifications.
Types
| Type | Example |
|---|---|
| ORDER_STATUS | An order moved to a new status. |
| ORDER_MESSAGE | A new message in an order's chat. |
| PAYMENT | A payment or payout succeeded or failed. |
| ACCOUNT_SECURITY | A password change, new sign-in, or similar. |
| PROMO | Marketing / promotional content. |
| SELLER_ONBOARDING | KYC and seller profile status updates. |
| SUPPORT | Updates on a support conversation. |
| SYSTEM | Platform-wide notices, e.g. incidents. |
Reading and managing
List a user's notifications (paginated, optionally filtered to unread), mark one or all as read, or delete one.
Preferences
A user can turn off delivery for any type they don't want to see, via PATCH /preferences/:type.
ACCOUNT_SECURITY can't be muted
Security-relevant notifications are forced regardless of preference — a user can't opt out of being told about a password change or new sign-in on their own account.
Staff-created notifications
Admins can create a notification directly — used for one-off announcements outside the normal event-driven flow.
Browse the Notifications endpoints in the API Reference