सामग्री पर जाएँ

Relay

अपनी सेवाओं को PushWard से जोड़ने का सबसे आसान तरीका। webhooks को relay.pushward.app पर भेजें — कोई Docker containers नहीं, कोई self-hosting नहीं, किसी per-user कॉन्फ़िगरेशन की ज़रूरत नहीं।

Supported Providers

Grafana

POST /grafana
notification

इवेंट

  • Firing
  • Resolved (grouped by alertname)
लाइव ऐक्टिविटी प्रदर्शन

Public Relay

PushWard hosts a public relay at relay.pushward.app — no deployment required. Just point your services at it with your integration key.

उदाहरण: Grafana webhook 
# Grafana Contact Point URL:
https://relay.pushward.app/grafana

# HTTP Header:
Authorization: Bearer hlk_YOUR_INTEGRATION_KEY
💡 सुझाव

The public relay supports all 19 providers listed above. If you prefer to self-host, see the self-hosted setup further down.

How It Works

pushward-relay extracts the hlk_ integration key from each incoming webhook request. The relay infrastructure scales horizontally — one instance can serve many users concurrently. Per-user usage is bounded by your account's plan (free tier monthly quotas; unlimited on paid).

  1. Receive — external services send webhooks to provider-specific routes
  2. Authenticate — the integration key is extracted from the Authorization: Bearer hlk_... header (or Basic Auth password for Radarr/Sonarr/Prowlarr/Bazarr/Komodo, or GenieKey for TrueNAS)
  3. Transform — the provider handler maps the webhook payload to a push notification or Live Activity update depending on the event type
  4. Forward — the request is sent to PushWard using the caller's integration key

Push Notifications vs Live Activities

Each provider delivers events as either a push notification (banner alert) or a Live Activity (Dynamic Island + Lock Screen), depending on the event type:

DeliveryProvidersUse case
Notification onlyGrafana, Prowlarr, BazarrOne-shot alerts — firing/resolved, health, grabs, subtitle downloads
Live Activity onlyArgoCD, Uptime Kuma, Backrest, Proxmox, Overseerr, Gatus, Changedetection, Paperless, Unmanic, Gitea, ForgejoMulti-step progress tracking (syncs, downloads, backups)
BothRadarr, Sonarr, Jellyfin, Komodo, TrueNASRadarr/Sonarr: Grab/Download → Live Activity; Health/Rename/Add/Delete → notification. Jellyfin: playback → Live Activity; library adds, scheduled tasks, auth failures → notification. Komodo: resolvable server conditions (CPU, memory, disk, unreachable, version mismatch, swarm) → Live Activity plus a companion notification; container state, build failed, image update → notification only. TrueNAS: each alert → Live Activity plus a companion notification
ℹ जानकारी

Relay requires PostgreSQL for persistent state (sync tracking, download lifecycle, playback progress across restarts and tenants). Stateless providers (Bazarr, Changedetection, Unmanic) still require a database connection to start.

ऐप संस्करण 1.7.0 में आ रहा है

यह अनुभाग एक ऐप अपडेट की उस सुविधा का वर्णन करता है जो App Store समीक्षा के लिए लंबित है। अपडेट लाइव होते ही यह यहाँ अपने आप अनलॉक हो जाएगा।

Per-request overrides

Append query parameters to any provider webhook URL to override that provider's delivery behavior for a single request. This is handy when one source should behave differently from the provider default — for example forcing a noisy alert to a plain notification, or bumping a deploy's priority. An explicit parameter always wins over the provider-computed value and your static config; omitting a parameter leaves today's behavior unchanged.

ParameterValuesEffect
channelsComma-separated: activity, notificationRestricts which delivery surfaces this request may use. channels=notification suppresses Live Activities and only sends push notifications; channels=activity does the reverse. Must list at least one valid surface.
priorityInteger 0-10Sets the eviction / relevance priority for any Live Activity the request creates.
levelpassive, active, time-sensitive, criticalSets the notification interruption level for any push notification the request sends.
Force a Grafana alert to a time-sensitive notification only 
https://relay.pushward.app/grafana?channels=notification&level=time-sensitive
⚠ चेतावनी

An invalid value is rejected with 400 before the webhook is processed — an unknown channels surface, a priority that isn't an integer 0-10, or a level outside the four allowed values. Fix the URL rather than retrying.

Setup

1. Get Your Integration Key

PushWard ऐप में Settings → Integration Key के अंतर्गत अपनी डिफ़ॉल्ट integration key कॉपी करें; साइन इन करने पर यह अपने-आप बन जाती है। किसी key को इस इंटीग्रेशन तक सीमित करने के लिए, देखें scoped keys बनाना।

2. Self-Hosted (Optional)

If you prefer to run your own relay instance:

docker-compose.yml 
services:
  pushward-relay:
    image: ghcr.io/mac-lucky/pushward-relay:latest
    ports:
      - "8090:8090"
    environment:
      PUSHWARD_URL: https://api.pushward.app
      PUSHWARD_DATABASE_DSN: postgres://user:pass@db:5432/relay?sslmode=disable
    restart: unless-stopped

  db:
    image: postgres:17-alpine
    environment:
      POSTGRES_USER: user
      POSTGRES_PASSWORD: pass
      POSTGRES_DB: relay
    volumes:
      - relay-data:/var/lib/postgresql/data

volumes:
  relay-data:
💡 सुझाव

For Radarr, Sonarr, and Prowlarr, use Basic Auth with the hlk_ key as the password (username is ignored), since their webhook settings only support Basic Auth.

Authentication

Three patterns depending on the provider:

MethodProvidersFormat
Bearer tokenMost providersAuthorization: Bearer hlk_...
Basic AuthRadarr, Sonarr, Prowlarr, Bazarr, Komodohlk_... as password
GenieKeyTrueNASAuthorization: GenieKey hlk_...

Configuration

Environment Variableविवरणडिफ़ॉल्ट
PUSHWARD_URLPushWard server URL--
PUSHWARD_DATABASE_DSNPostgreSQL connection string--
PUSHWARD_SERVER_ADDRESSHTTP listen address:8090

Each provider can be individually enabled/disabled and configured with its own priority, cleanup delay, and stale timeout via environment variables or YAML config.