Version: 1.0.0
Notification
Notification dispatch, history, and lifecycle management across three delivery channels.
Delivery channels (contactChannel)
| Value | Channel | Identifier format |
|---|---|---|
SMS | Text message | E.164 phone number (+61491570006) |
EMAIL | RFC 5322 email address | |
DEVICE | Mobile push notification | Device token / registration ID |
Message types (messageType)
| Value | Purpose | Template required | Schedulable |
|---|---|---|---|
MARKETING | Promotional campaigns; can target non-registered parties | Yes | Yes |
VERIFICATION | Onboarding / identity verification; immediate delivery only | Yes | No |
GENERAL | Account and operational alerts for authenticated parties; template or free text | No | Yes |
Notification status (status)
| Value | Meaning |
|---|---|
NEW | Queued for processing; cancellable |
SCHEDULED_DELIVERY | Awaiting a scheduled future delivery time; cancellable |
DELIVERED | Successfully delivered; terminal success state |
ERROR | Delivery failed permanently; terminal failure state |
CANCELLED | Cancelled before delivery; terminal state |
Conventions
- Resource IDs are UUIDs.
- Errors follow the standard envelope
{ errorCode, message, timestamp, traceId }whereerrorCodeuses the pattern{DOMAIN}{CLASSIFICATION}{SEQUENCE}(e.g.NOT004001). - Party and user context are resolved from the JWT; supply
x-party-id,x-brand-id, orx-client-idheaders where admin override is needed. - Channel identifiers are masked in responses for privacy (e.g.
+614915****06).
Authentication
- HTTP: Bearer Auth
- OAuth 2.0: OAuth2
| Security Scheme Type: | http |
|---|---|
| HTTP Authorization Scheme: | bearer |
| Bearer format: | JWT |
| Security Scheme Type: | oauth2 |
|---|---|
| OAuth Flow (clientCredentials): | Scopes: |