PUSH API · v1a

Core concepts

Even for the same app, different environments have separate keys, devices, push service connections and message targets. Check the active scope before acting.

ConceptMeaning
OrganizationGroups the accounts and projects operated together.
ProjectGroups related apps. Project environments separate shared user data and definitions.
AppA client application, such as an Android or iOS app.
App environmentThe scope for keys, push service connections, installations and messages. A key is pinned to one app environment.
App userA user identity. Enrollment creates an anonymous user. Managed login uses device authentication plus an external ID in BASIC, or a JWT from your trusted backend in VERIFIED. BASIC does not verify ownership of the ID.
App installationOne installation of an app on a device. A user may have several installations.
Push subscription and addressA push delivery route for an installation. Forward new FCM/APNs addresses to the SDK when they change.
Message and deliveryA message is the send request; a delivery is the processing outcome for one subscription.

Three different settings

  • OS notification permission: whether the operating system allows notifications.
  • App push preference: whether the user opted into push inside the app.
  • Marketing consent: a separate record for marketing messages. OS permission and push preference do not replace it.