Endpoints

An endpoint is a delivery destination for notifications.

Panels

Panels display notifications in real time on a dedicated screen.

Android App

Install the Notifiq Android app, configure it with your server URL and an API token. The app maintains a persistent connection and displays incoming alerts immediately.

Modes:

• Feed — scrollable list of recent messages
• Alert — full-screen overlay for notifications

Linux App

A desktop application that shows Notifiq notifications.

Docker Panel

A lightweight browser-based panel served as a Docker container. Useful for dedicated display screens (TV, monitor) without installing a native app.

Setup:

1. Download the panel files:

   • docker-compose.yml
   • .env.example

2. Configure .env:

# URL of your Notifiq server
NOTIFIQ_URL=https://notifiq.yourdomain.com

# API token — create one in Settings → API Tokens
API_TOKEN=your-api-token

# Optional
PANEL_ID=panel-1
PANEL_NAME=Office Panel
DEFAULT_MODE=feed

3. Start the panel:

docker compose up -d

The panel is then available at http://<host>:8081.

Display modes:

• Feed — scrollable list of recent messages
• Alert — full-screen overlay, one message at a time

Email

Send notifications as emails via any SMTP server.

Customizable in Templates.

Matrix

Send messages to a Matrix room.

Setup:

1. Create a bot account on your Matrix homeserver
2. Get an access token
3. Invite the bot to your target room
4. Add the endpoint with the room ID and access token

Customizable in Templates.

Telegram

Send messages to a Telegram chat via a bot.

Setup:

1. Create a bot via @BotFather
2. Get the bot token
3. Get the chat ID (send a message to the bot, then call /getUpdates)
4. Add the endpoint in Endpoints → Telegram

Customizable in Templates.

Webhooks

POST a JSON payload to any URL on notification delivery.

The payload includes the full message object. Use this to integrate with:

• Slack (via incoming webhooks)
• PagerDuty
• Custom automation scripts
• Log aggregators