Skip to main content

​
Overview

Notifiers deliver messages from automations or the notify tool. They are configured separately from automation creation. Supported types include:
TypeTypical fields
telegramuser_id
emailfrom_account, to_address
slackchannel
bashcommand

​
List enabled notifier names

curl http://localhost:6877/notifiers \
  -H "Authorization: Bearer $API_KEY"

​
List configs

curl http://localhost:6877/notifiers/configs \
  -H "Authorization: Bearer $API_KEY"

​
List notifier types

curl http://localhost:6877/notifiers/types \
  -H "Authorization: Bearer $API_KEY"

​
Create config

Telegram: 
curl -X POST http://localhost:6877/notifiers/configs \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"telegram-me","type":"telegram","config":{"user_id":"123456"}}'
Email: 
curl -X POST http://localhost:6877/notifiers/configs \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"email-me","type":"email","config":{"from_account":"me@example.com","to_address":"me@example.com"}}'
Slack: 
curl -X POST http://localhost:6877/notifiers/configs \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"slack-alerts","type":"slack","config":{"channel":"#alerts"}}'
Bash: 
curl -X POST http://localhost:6877/notifiers/configs \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"local-notify","type":"bash","config":{"command":"osascript -e '\''display notification $NTRP_BODY with title $NTRP_SUBJECT'\''"}}'

​
Update config

curl -X PUT http://localhost:6877/notifiers/configs/telegram-me \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"telegram","config":{"user_id":"123456"}}'

​
Test config

curl -X POST http://localhost:6877/notifiers/configs/telegram-me/test \
  -H "Authorization: Bearer $API_KEY"

​
Delete config

curl -X DELETE http://localhost:6877/notifiers/configs/telegram-me \
  -H "Authorization: Bearer $API_KEY"