Getting started

This guide will walk you through the steps to set up Notifery and send your first event and notification.

Step 1: Create your account

1. Visit app.notifery.com.
2. Click on “Sign In” and choose your preferred authentication method (Google or GitHub).
3. Complete the authentication process to create your account.

Step 2: Configure notifications

After signing in, you have two ways to receive notifications:

• Push notifications: Browser-level notifications delivered by your operating system. Requires granting push permission and works in Chrome, Firefox, and Edge.
• In-app toasts: Transient popups within the application. Work in any browser without needing push permission and can play a custom sound.

By default, new devices use “Push & toast” mode (both types). You can change this at any time in your profile settings.

To enable push notifications:

1. When the browser permission dialog appears, click “Allow” to enable notifications.
2. If you accidentally dismissed the prompt, you can enable notifications later through the Devices section in your profile.
3. Your device will be registered and begin receiving push notifications alongside in-app toasts.

Tip

Prefer not to grant push permission? Switch to “Toast only” mode in settings. You’ll still get visual and audible alerts while the app is open.

Step 3: Configure multiple devices (optional)

To receive notifications on multiple devices:

1. Sign in to app.notifery.com on each additional device.
2. Enable push notifications when prompted on each device, or choose toast-only mode if you prefer.
3. You can view and manage all your registered devices in the Profile > Devices section.
4. Each device can have its own notification mode configured independently in Profile > Settings.

Tip

For the best experience, we recommend setting up notifications on your mobile device using a modern browser like Chrome or Firefox.

Step 4: Create your first zone

Zones in Notifery are containers for organizing your notifications:

1. From the dashboard, click on “Zones” in the left sidebar.
2. Click “Create zone” or “Create your first zone” button.
3. Enter a name for your zone (e.g., “My Project”).
4. The system will automatically generate an alias based on your zone name. You can customize this alias if needed.
5. Click “Create” to finalize.

Step 5: Generate an API key

To send notifications, you’ll need an API key:

1. Navigate to your newly created zone.
2. Click on “Settings” in the zone menu.
3. Scroll down to the “API keys” section.
4. Click “Create API key”.
5. Copy it, we will use it in the next step.

Step 6: Send your first notification

Now you’re ready to send your first notification using the Notifery API:

Using cURL

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{"title":"Hello","message":"World","zone":"YOUR_ZONE_ALIAS"}' \
  https://api.notifery.com/event

Replace YOUR_API_KEY with the API key you generated and YOUR_ZONE_ALIAS with your zone’s alias.

Using JavaScript

fetch('https://api.notifery.com/event', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'YOUR_API_KEY',
  },
  body: JSON.stringify({
    title: 'Hello',
    message: 'World',
    zone: 'YOUR_ZONE_ALIAS',
  }),
})
  .then((response) => console.log('Notification sent!'))
  .catch((error) => console.error('Error:', error))

Using Python

import requests

response = requests.post(
    'https://api.notifery.com/event',
    headers={
        'Content-Type': 'application/json',
        'x-api-key': 'YOUR_API_KEY'
    },
    json={
        'title': 'Hello',
        'message': 'World',
        'zone': 'YOUR_ZONE_ALIAS'
    }
)

print(f"Status code: {response.status_code}")

Step 7: Create groups (optional)

For better organization, you can create groups within your zone:

1. Navigate to your zone’s settings.
2. Click on “Groups” in the settings menu.
3. Click “Create new group”.
4. Provide a name and alias for your group.
5. When sending notifications, include the group parameter in your API requests:

Tip

Notification settings can be configured for each group.

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: 'YOUR_API_KEY' \
  -d '{"title":"Hello","message":"World","zone":"YOUR_ZONE_ALIAS","group":"YOUR_GROUP_ALIAS"}' \
  https://api.notifery.com/event