Skip to main content

HTTP Webhooks

The http trigger executes custom HTTP/REST webhooks with configurable methods, headers, and body payloads whenever updates are detected.

⚙️ Configuration Variables​

WUD_TRIGGER_HTTP_{trigger_name}_URL
Requiredurl

Target webhook URL

Allowed values:Valid HTTP or HTTPS endpoint
WUD_TRIGGER_HTTP_{trigger_name}_AUTH_BEARER
Optionalstring

Bearer token for Bearer authentication

WUD_TRIGGER_HTTP_{trigger_name}_AUTH_PASSWORD
Optionalstring

Password for Basic authentication

WUD_TRIGGER_HTTP_{trigger_name}_AUTH_TYPE
Optionalenumdefault: BASIC

Authentication mechanism

Allowed values:`BASIC`, `BEARER`
WUD_TRIGGER_HTTP_{trigger_name}_AUTH_USER
Optionalstring

Username for Basic authentication

WUD_TRIGGER_HTTP_{trigger_name}_METHOD
Optionalenumdefault: POST

HTTP request method

Allowed values:`GET`, `POST`
WUD_TRIGGER_HTTP_{trigger_name}_PROXY
Optionalurl

HTTP/HTTPS proxy server URL

Allowed values:Valid HTTP/HTTPS proxy URL
info

This trigger also supports all common trigger configuration options (such as thresholds, scheduling, and batching).

🚀 Examples​

Dispatch an Authenticated POST Webhook​

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_TRIGGER_HTTP_LOCAL_URL=https://api.example.com/webhooks/container-updates
      - WUD_TRIGGER_HTTP_LOCAL_METHOD=POST
      - WUD_TRIGGER_HTTP_LOCAL_AUTH_TYPE=BEARER
      - WUD_TRIGGER_HTTP_LOCAL_AUTH_BEARER=your_secret_bearer_token

📦 Webhook Payload Format​

In POST mode, WUD transmits a JSON payload containing the discovered update:

{
  "id": "31a61a8305ef1fc9a71fa4f20a68d7ec88b28e32303bbc4a5f192e851165b816",
  "name": "homeassistant",
  "watcher": "local",
  "includeTags": "^\\d+\\.\\d+\\.\\d+$",
  "image": {
    "id": "sha256:d4a6fafb7d4da37495e5c9be3242590be24a87d7edcc4f79761098889c54fca6",
    "registry": {
      "url": "hub.docker.com"
    },
    "name": "homeassistant/home-assistant",
    "tag": {
      "value": "2024.6.4",
      "semver": true
    },
    "digest": {
      "watch": false,
      "repo": "sha256:ca0edc3fb0b4647963629bdfccbb3ccfa352184b45a9b4145832000c2878dd72"
    },
    "architecture": "amd64",
    "os": "linux",
    "created": "2024-06-12T05:33:38.440Z"
  },
  "result": {
    "tag": "2024.6.5"
  },
  "updateAvailable": true
}