webhook شامل

وجّه الـ webhook بصيغة JSON من أي خدمة إلى Relay واحصل على إشعار على iPhone. الخدمات التي يعرفها PushWard تحصل على إعداد مسبق، مع أنشطة مباشرة للتنبيهات.

Get Your Integration Key

استخدم مفتاح التكامل الافتراضي من تطبيق PushWard ضمن الإعدادات → مفتاح التكامل، أو أنشئ مفتاحًا محدود النطاق لهذا التكامل.

Send a webhook

Set the service's webhook URL to the relay root, https://relay.pushward.app/, and send your key as a Bearer token. The body can be any JSON object or array up to 1 MB. There is nothing to set up or confirm: the first event arrives like every other.

curl -X POST "https://relay.pushward.app/?source=backup" \
  -H "Authorization: Bearer hlk_..." \
  -H "Content-Type: application/json" \
  -d '{"job":"nightly-offsite","status":"finished","message":"Uploaded 1000 chunks in 42 minutes"}'

Plenty of services can only set a URL. Put the key in it as the Basic Auth password; the username is ignored:

https://pushward:[email protected]/?source=backup

Name the sender

?source= is optional, but set it. Each source's notifications get their own thread, a payload with no title of its own is titled after it, and it is the subtitle on cards. A few presets only apply when the source names their service (see the table below). It takes lowercase letters, digits and dashes, up to 32 characters; anything else is a 422.

Services the relay already knows

Before anything else, the relay checks whether the payload comes from one of its providers. A recognised payload is handled exactly as if it had been posted to that provider's route: same Live Activity, same query parameters, same response.

Detection is deliberately conservative, so when a service lets you set the path, use its own route anyway. Payloads from GitHub, GitLab, Bitbucket and Sentry (recognised by their event headers), and from Lidarr, Readarr and Whisparr (by their User-Agent), go to the universal webhook with the service's name as their source, unless you set one.

Presets

For services whose webhook format is documented, the relay ships a preset: which field is the title, the body, the link, what keys one alert, and what each status and severity value means. A preset is picked by the fields a payload has, never by guessing from its values, so every event of a kind arrives the same way. Alert-style services open an alert Live Activity that updates as the alert changes and resolves in green when it clears. CI runs and deploys open a progress card that finishes as "Done", or in red when the run failed.

A service missing here still works: its events arrive as notifications, described next.

Everything else: a notification

A payload no preset knows becomes one notification. The relay flattens the JSON into field paths such as data.check.name and picks the field that reads most like a title, the one that reads most like a body, and a link, by their names and what they hold. When the payload has no title of its own, the source is the title. When it has no body, the body lists up to four of its most readable fields. For example, a payload of only {"host":"nas-01","disk":"/srv","used":"93%","id":"8d3f5a1e-..."} posted with ?source=disk-check arrives as:

Disk check
Disk: /srv
Host: nas-01
Used: 93%

Ids, timestamps and links are left out of those lines, and anything that looks like a credential, token, email address, card or phone number is masked. Each event is picked on its own, so a notification never depends on an earlier one.

Query parameters

The relay's per-request overrides work here too, next to source, and pass through to whichever route handles the request.

• channels=notification never opens a card; card events arrive as notifications instead. channels=activity drops notifications, so a payload that would be a notification delivers nothing.
• priority (0-10) sets the priority of cards the request opens.
• level overrides the interruption level of every notification the event sends.

https://relay.pushward.app/?source=alertmanager&channels=notification&level=time-sensitive

https://relay.pushward.app/?source=alertmanager&ack=1&ack_repeat=120

Responses

Limits

• Up to 256 fields per payload and 8 levels of nesting. Values are cut at 256 characters.
• Only the first element of an array is read. An Alertmanager group with three alerts is shown from the first one.

What the relay keeps

Nothing about your payloads. Each event is mapped and delivered on its own and then forgotten. While a preset's card is open, the relay keeps a hash of your key and of the value that keys the card, so the next event finds it; that entry goes when the card ends.

Self-hosted relay

The universal webhook is off by default on a self-hosted relay, and while it is off, POST / still hands recognised payloads to their providers and answers 404 for everything else. To turn it on: