API Keys

API keys are essential for authenticating requests when sending events to your Notifery zones. This guide covers how to create, manage, and use API keys securely.

Understanding API Keys

An API key is a unique identifier that authenticates your requests to the Notifery API. Each zone has its own API key(s) to:

• Ensure only authorized sources can send events to your zone
• Track which systems are sending events
• Prevent unauthorized access to your notification system

Caution

API keys should be treated as sensitive credentials. Never share your API keys publicly or commit them to version control systems.

Accessing API Key Management

API keys can be managed in the zone settings:

1. Navigate to your zone
2. Click on “Settings” in the zone header (admin access required)
3. Scroll down to the “API keys” section in the General settings tab

Creating an API Key

To create a new API key:

1. In the API keys section, click “Create API key”
2. The new API key will be generated and displayed immediately
3. Copy the API key to a secure location

Note

As for now, each zone can have only one active API key.

Using API Keys

You can use your API key to authenticate requests to the Notifery API in two ways:

Via HTTP Header (Recommended)

fetch('https://api.notifery.com/event', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'your-api-key-here',
  },
  body: JSON.stringify({
    title: 'Test Event',
    message: 'This is a test event',
  }),
})

Via Request Body

fetch('https://api.notifery.com/event', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    apiKey: 'your-api-key-here',
    title: 'Test Event',
    message: 'This is a test event',
  }),
})

Tip

Using the x-api-key header is preferred for security reasons, as it keeps the API key out of request logs and URL parameters.

API Key Security Best Practices

To keep your API keys secure:

1. Store securely - Use environment variables or a secure secrets manager
2. Limit access - Only share with team members who need to integrate with Notifery

API Key Limitations

• Each zone can have one active API key (this limit may change in future versions)
• API keys are specific to a zone and cannot be used across multiple zones
• All events sent using a zone’s API key will be associated with that zone