Developer docs

PUSH API · v1a

Supported capabilities

Currently supported

  • Native Android and iOS SDKs: enrollment, address updates and exact unregister, permission observations, push preferences and durable synchronization.
  • FCM FID or legacy registration-token mode, and APNs sandbox or APNs production. The host app owns push service setup and OS callbacks.
  • New SDK convenience initialization reads the server BASIC/VERIFIED policy automatically. Each project environment has one mode that applies to all of its apps. The first app of a project environment starts in BASIC; apps added later follow that environment’s mode. BASIC uses an external ID, while VERIFIED requires a JWT from your trusted backend after session verification. A failed policy read never switches to BASIC. The SDK manages device authentication, binding and retries. Do not mix this with identify/logout/transfer or embed server or private keys in an app.
  • OS_DISPLAY notifications, public API single/multiple-target messages, authorized broadcasts, status/delivery inspection and operational controls, subject to permissions and rollout conditions.
  • Optional iOS image Notification Service Extension, host-registered iOS buttons, and an Android helper for host-rendered foreground buttons. Installing the SDK alone does not install an extension or register buttons.
  • Actual receipt/click reports require message track_events and SDK notificationEventsEnabled. Updated SDK source defaults collection on while respecting saved opt-outs. New dashboard content starts with reports enabled; existing drafts, copies and omitted API fields are not changed.

Not promised by this release

  • Web push, browser SDKs, React Native/Flutter wrappers and a macOS app SDK are outside this native integration support scope.
  • The message API does not accept APP_DISPLAY as an authored display_path. Android SDK-managed display is selected automatically from the capabilities registered by a compatible SDK. Do not add undocumented fields or unsupported enum values.
  • No complete device delivery, display or click-through-rate measurement is promised. Optional callback observations have gaps; clicks never synthesize receipts. Arbitrary Android background OS_DISPLAY buttons are not supported.
  • Do not assume immediate installation from Maven Central or a public Swift Package URL. Confirm an approved artifact and compatible version.
  • These static docs have no credential-input playground or live send button. They make no service availability, delivery-rate or release-date guarantees.