The documentation is currently a work in progress whilst the product is in alpha.

License Keys

Release builds require a valid license key. Learn how to add yours to the project.

Notifee is a licensed product and requires a valid license key to work when your application has been built in release mode.

If an invalid license key is provided, your application will still continue to work as normal. However, all features provided by notifee will not work.

Notifee will deem a license key to be invalid under the following scenarios:

  • No key is provided in the notifee.config.json file (see below).
  • [Android] The Application ID does not match the provided ID when generating the key.
  • [iOS] The Bundle ID does not match the provided ID when generating the key.
  • The key is no longer valid (e.g. key has been removed via the dashboard).

Creating a key

To create a key, you need to have purchased a license or be assigned to a team with a license.

Once a license has been purchased, navigate to the license page on your account dashboard. Here, you are able to create two types of keys; Primary & Secondary. Choose the key type you wish to use with your application:

Key Type
Primary KeysUsed on production release build applications.
Secondary KeysUsed on release build applications which are not intended for production use, for example, staging or testing applications.

Secondary keys are subject to more frequent checks on their validation. They are designed for non-production applications only and may unexpectedly be invalidated if used on high traffic applications.

Using a key

To use a license key with your application, first create a file called notifee.config.json in the root of your project. This file accepts keys for both Android & iOS. Copy and add the key to this file, for example:

{
  "android": {
    "license": "XXXX.YYYY.ZZZZ"
  },
  "ios": {
    "license": "XXXX.YYYY.ZZZZ"
  }
}

Now rebuild your project, the keys will be validated when the application is launched:

# For iOS
npx react-native run-ios

# For Android
npx react-native run-android

Copyright 2020 © Invertase Limited

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License and code samples are licensed under the Apache 2.0 License.

All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.