Documentation
Getting Started
API Key

API Key

To use Notifier, you need to configure an API key to be able to send notifications to your users. The page will guide you through the steps to create an api key that only has the required permissions to send notifications.

Create the key

This key grants the Notifier service permission to send notifications.

Note

You must create this key from the account or group that owns the experience.

  1. Navigate to the Creator Dashboard Credentials page.
  2. Click Create API Key.

Create Key

Name the Key

The name and description can be anything of your choosing.

Name Key

Access Permissions

In the “Access Permissions” section, configure the following:

  1. API System: Select Notifications.
  2. Experience: Add your target experience.
  3. Permissions: Select Write.

Set Permissions

Security

In the “Security” section, carefully configure the following settings:

  1. IP Address: Add the 0.0.0.0/0 IP address range.

    Warning

    Using 0.0.0.0/0 allows requests from any IP address. This is necessary for the Notifier service to function, but it means you must keep this key extremely secret. If this key is leaked, anyone can use it from any location.

  2. Expiration: Set the expiration to No Expiration.
  3. Click Generate API Key.

Security

Note

After generating the api key, send it to @Ocipa from BlackLeaf so they can add it to your account.

Notification Strings