Documentation Home KeepSafe Messenger Home
KeepSafe Messenger Documentation
Base URL: https://messenger.keepsafe.ai
Swagger Reference
Use the interactive Swagger UI for request/response schemas, authentication, and machine-readable OpenAPI metadata.
API Areas
| Area | Use |
|---|---|
| Push Notifications | Register app device tokens and send standard APNs/FCM-style notifications. |
| Live Activities | Register ActivityKit Live Activity push tokens and send update/end events. |
| SMS Messages | Register app SMS recipients and send targeted or broadcast text messages. |
| Email Messages | Register app email recipients and send targeted or broadcast email messages. |
| Slack Webhooks | Register app Slack incoming webhooks and send targeted or broadcast Slack messages. |
Authentication
App API calls use an app API token generated from the admin setup flow. Send it as a bearer token.
Authorization: Bearer <API_TOKEN>| Scope | Purpose |
|---|---|
device:write | Register or update device push tokens, ActivityKit Live Activity push tokens, SMS recipients, and email recipients. |
slack:write | Register or update Slack incoming webhook recipients. |
push:send | Initiate push notifications and Live Activity updates. |
sms:send | Initiate SMS messages through AWS End User Messaging. |
email:send | Initiate email messages through SendGrid. |
slack:send | Initiate Slack messages through registered incoming webhooks. |
admin | Admin-level API access. |
Admin Invitations
Manage Users invitations require SSO_ADMIN_TOKEN. KeepSafe Messenger uses it to create the SSO app user when needed, ask SSO for a login URL without sending email, then delivers and audits the invitation through the Messenger email pipeline.
Admin Web Sending
From the main admin page, choose Push Notifications, Live Events, SMS Messages, Email Messages, or Slack Webhooks for an app. Each delivery type has its own send form and recent event history.