API Key Management

Your API Key is a unique identifier used to authenticate your requests to the AlertWise API.
It allows integrations such as WordPress plugins, custom scripts, and applications to communicate securely with the AlertWise platform.

Understanding the API Key

• Your API key is unique to your account.
• It should be kept secret and secure at all times.
• Anyone with access to your API key can send notifications from your app.

Caution

Do not expose your REST API key in public code repositories (like GitHub), websites, or online forums. If exposed, it could be used without your permission.

When to Regenerate the API Key

You should regenerate your API key if:

• You suspect it has been compromised.
• You accidentally published it online.
• You want to rotate credentials for security purposes.

Confirm Warning Before Regeneration

When you attempt to regenerate your API key, you will see:

Are you sure you want to rotate the API key?

If you change the API key, you will need to update it wherever it is used, such as in WordPress plugins and other integrations.

Important: After regenerating, you must update all applications, scripts, or plugins that use the old key. Failure to do so will cause integrations to stop working.

Deleting the API Key

Deleting your API key will completely disable any integrations using it.

Confirm Warning Before Deletion

When you attempt to delete your API key, you will see:

Are you sure you want to delete the API key?

If you delete the API key, your existing integration will start failing, such as in WordPress plugins and other integrations.

Only delete your API key if you no longer use it or are replacing it with a new one.

API Key Best Practices

• Keep it confidential – Never share it publicly.
• Limit access – Only store it where it’s needed for integration.
• Rotate regularly – Periodically regenerate to improve security.
• Update immediately – When you regenerate, replace the key in all your connected services.