Skip to main content

API Keys

It's possible to generate API keys for your plugin. There are two main uses for them.

Sending notifications#

It is required to use an API key for sending notifications. For more info see the notifications section.

Simplifying / automating the publishing of your plugin#

You can publish your plugin without an API key, by simply using your real Reach user for it. However, you may want to publish your plugin within an automated process or via an API call. For this purpose it also makes sense to use a long living API key.

Generating a key#

You can generate a key by running the following command:

  • npm run generate-api-key

This command will open a dialog inside Reach where you will have to provide at least a Display name and optionally an expiry date. Make sure you save this key as you won't be able to get it back if you close the dialog.

caution

You should also ensure that this key is not exposed to the client or to any other "third parties", since it would allow them to send notifications or publish your plugin.