Authentication

How to authenticate with the Notification Service API using JWT tokens.

Overview

All endpoints (except Health, Webhooks, and Jobs) require a Bearer JWT token. The tenantId is extracted from the JWT claims automatically via the @CurrentTenant() decorator.

Obtaining a JWT Token

curl -X POST https://535ubezkse.execute-api.us-east-1.amazonaws.com/auth/v1/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dev@eventzr.com",
    "password": "Password123!"
  }'

# Response:
# {
#   "data": {
#     "accessToken": "eyJhbGciOiJSUzI1NiIs...",
#     "refreshToken": "eyJhbGciOiJSUzI1NiIs...",
#     "expiresIn": 3600
#   }
# }

Use the token with notify-svcbash

export TOKEN="<access-token-from-response>"

curl -X GET https://535ubezkse.execute-api.us-east-1.amazonaws.com/notify/v1/deliveries \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

Refresh an expired tokenbash

curl -X POST https://535ubezkse.execute-api.us-east-1.amazonaws.com/auth/v1/refresh \
  -H "Content-Type: application/json" \
  -d '{ "refreshToken": "eyJhbGciOiJSUzI1NiIs..." }'

Test Credentials

Staging Environment Credentials

Use these credentials to test the API in the Scalar playground above.

Role	Email	Password	Tenant ID
Developer	`dev@eventzr.com`	`Password123!`	`00000000-...-000001`
Admin	`admin@eventzr.com`	`Password123!`	`00000000-...-000001`

Role-Based Access Control

Role	Permissions
`user`	Read own deliveries, preferences, notifications, metrics, suppressions
`organizer`	Send notifications, manage templates, manage preferences, test sends
`admin`	Full access: delete, quota management, provider status, cancel deliveries

JWT Claims Structure

Decoded JWT payloadjson

{
  "sub": "user-uuid",
  "tenantId": "tenant-uuid",
  "email": "user@example.com",
  "roles": ["user", "organizer", "admin"],
  "planTier": "professional",
  "iat": 1740000000,
  "exp": 1740003600
}

Standard Headers

Header	Required	Description
`Authorization`	Yes	Bearer JWT token
`Content-Type`	POST/PUT/PATCH	application/json
`x-request-id`	No	Request trace ID (UUID), auto-generated if absent
`x-tenant-id`	Auto	Extracted from JWT tenantId claim
`Idempotency-Key`	No	Idempotency key for write operations (24h TTL)

Authentication by Controller

Controller	Auth Method
Delivery, Templates, Preferences, Suppression, Metrics, Admin	`@UseGuards(JwtAuthGuard, RolesGuard)`
Webhooks	`Webhook signature verification (no JWT)`
Jobs	`@UseGuards(InternalApiKeyGuard)`
Health	`None (public)`

Response Envelope

Standard response formatjson

{
  "data": { ... },
  "error": null,
  "page": {
    "next_cursor": "eyJwYWdlIjoyLCJsaW1pdCI6MjB9",
    "has_more": true,
    "limit": 20
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "trace_id": "abc123",
    "tenant_id": "tenant-uuid"
  }
}