Skip to content

Term confusion ApiKey / NOVU_SECRET_KEY #836

@paul-github-1

Description

@paul-github-1

This happens a lot throughout the docs, but let me point out just this case:

Page: https://docs.novu.co/api-reference/overview

Authentication Header

`--header 'Authorization: ApiKey <NOVU_SECRET_KEY>'``

Description says "Authentication for the Novu API involves the use of an API Key, which is a secure credential that is tied to your Novu account."

For someone coming to novu for the first time, this needs clarity:

  • Production Api Key from the dashboard?
  • Developement Api Key from the dashboard?
  • VM: Novu/Docker/Community/.env "NOVU_SECRET_KEY" ?

These keys have entirely different scopes and it takes a long time to get a grip of what you're actually referring to. This confusion makes integrating with novu a longer process than it should be. Bigger learning curve just to get things working.

In this specific case: the intention is to use the api key from the dashboard: production or development environment.

Thanks to everyone's contributions. 🙏

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions