Relay

The easiest way to connect your services to PushWard. Point webhooks at relay.pushward.app — no Docker containers, no self-hosting, no per-user configuration needed.

Supported Providers

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 Contact Point URL:
https://relay.pushward.app/grafana

# HTTP Header:
Authorization: Bearer hlk_YOUR_INTEGRATION_KEY

How It Works

pushward-relay extracts the hlk_ integration key from each incoming webhook request. One relay instance serves unlimited users simultaneously.

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)
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:

Setup

1. Get Your Integration Key

Open the PushWard app → Settings → Integration Key to find your default hlk_ key.

To create a dedicated key for this integration:

1. Go to Settings → Manage Keys
2. Tap +
3. Set name (e.g. "Relay"), choose scope, and optionally restrict tografana-*, argocd-*
4. Copy the generated hlk_ key

2. Self-Hosted (Optional)

If you prefer to run your own relay instance:

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:

Authentication

Two patterns depending on the provider:

Configuration

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