Webhook receiver for Apprise
Allows to receive JSON messages and send them to Apprise API using a custom template.
-
Installed Apprise API
-
A template for converting a message from webhook. Templates are using nunjucks templating engine. Built-in templates:
alertmanager
- Prometheus Alertmanager templatediun
- diun template
These templates use Markdown formatting and may not be suitable for all notification services. You can create your own templates and mount them as volumes to
/app
folder.
-
Default address is
http://apprise-webhook:3000
. You can customise the behavior using query parameters:template
- template name which should be used (excluding.njk
)key
- key to append to Apprise URL (e.g.http://apprise:8000/notify/key
)title
- title to pass to Apprise APItype
- type to pass to Apprise APItag
- tag to pass to Apprise API
-
Environment variables
APPRISE_URL
- Apprise API URL (required)TEMPLATE
- Default template (required iftemplate
query parameter is not used)APPRISE_KEY
- Default key for Apprise API (optional)
-
docker-compose example
apprise: container_name: apprise image: caronc/apprise restart: unless-stopped environment: APPRISE_STATELESS_URLS: tgram://${TELEGRAM_LOGGER_TOKEN}/${TELEGRAM_LOGGER_CHATID}?format=markdown apprise-webhook: container_name: apprise-webhook image: zzeneg/apprise-webhook restart: unless-stopped environment: APPRISE_URL: http://apprise:8000/notify TEMPLATE: mywebhook APPRISE_KEY: docker volumes: - ./mywebhook.njk:/app/mywebhook.njk #custom template
-
Alertmanager configuration (
alertmanager.yml
)route: receiver: 'apprise' receivers: - name: 'apprise' webhook_configs: - send_resolved: true url: http://apprise-webhook:3000?template=alertmanager&key=logger
-
Diun configuration (
diun.yml
)notif: webhook: enable: true endpoint: http://apprise-webhook:3000?template=diun&title=*Diun* method: POST