Skip to content

Quickstart

Get started with Notifer in 5 minutes.

Step 1: Create Your First Topic

Before you can publish messages, you need to create a topic. You can do this in two ways:

  1. Go to app.notifer.io
  2. Click "Create Topic" button
  3. Enter topic name: my-first-topic
  4. Choose Public (anyone can subscribe) or Private (restricted access)
  5. Click Create

Option B: Using the API (requires authentication)

curl -X POST https://app.notifer.io/api/topics \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-first-topic",
    "access_level": "public",
    "is_discoverable": true
  }'

Step 2: Publish Your First Message

Now you can publish to your topic using curl:

curl -d "Hello from Notifer!" https://app.notifer.io/my-first-topic

That's it! You just published your first message to the topic my-first-topic.

Step 3: View Messages in the App

Log in to app.notifer.io and navigate to your topic:

https://app.notifer.io/topic/my-first-topic

You'll see your message appear in real-time! Try publishing another message from your terminal - it will show up instantly.

Account required

You need to be logged in to view topics in the web app. Create a free account to get started.

Step 4: Add Message Details

Make your notifications more useful with titles, priority, and tags:

curl -d "Deployment completed successfully" \
  -H "X-Title: Production Deploy" \
  -H "X-Priority: 4" \
  -H "X-Tags: deploy,production,success" \
  https://app.notifer.io/my-deployments

Message Parameters:

  • X-Title - Message title (shown in bold)
  • X-Priority - Priority level 1-5 (1=min, 3=default, 5=max/urgent)
  • X-Tags - Comma-separated tags for filtering

Topic Must Exist

Remember to create the my-deployments topic first (using the web app or API) before publishing to it.

Step 5: Subscribe for Push Notifications

To receive push notifications on your phone, you need to create an account and subscribe to topics.

  1. Create an account at app.notifer.io (email or Google sign-in)
  2. Download the mobile app:
  3. Log in to the app with your account
  4. Subscribe to my-first-topic to receive push notifications

Account required

Push notifications require an account. Without an account, you can still view public topics in your browser but won't receive notifications.

Step 6: Use Markdown Formatting

Messages support Markdown for rich text:

curl -d "**Bold text**, *italic*, \`code\`, and [links](https://example.com)" \
  https://app.notifer.io/my-first-topic

The formatted message will appear in the web and mobile apps.

Real-World Examples

Create Topics First

All examples below assume the topics already exist. Create them first using the web app or API before publishing messages.

Server Monitoring

# Send when disk space is low
curl -d "Disk usage: 85% - cleanup required" \
  -H "X-Priority: 4" \
  -H "X-Tags: server,disk,warning" \
  https://app.notifer.io/server-alerts

CI/CD Pipeline

# Notify when build completes
curl -d "Build #123 completed in 4m 32s" \
  -H "X-Title: Build Success" \
  -H "X-Tags: ci,build,success" \
  https://app.notifer.io/ci-notifications

Home Automation

# Alert when door opens
curl -d "Front door opened" \
  -H "X-Priority: 5" \
  -H "X-Tags: home,security" \
  https://app.notifer.io/home-security

Next Steps

Quick Reference

  • Creating topics: Requires an account (login via email or Google)
  • Publishing to public topics: No account needed
  • Publishing to private topics: Requires authentication (API key or topic token)
  • Viewing public topics: No account needed - open the topic URL in browser
  • Push notifications: Requires an account and subscription in web/mobile app
  • Private topics: Only owner and authorized users can access