Skip to content

Rocket.Chat notifications

Allow sending notifications to your Rocket.Chat channel.

Configuration

File

notif:
  rocketchat:
    endpoint: http://rocket.foo.com:3000
    channel: "#general"
    userID: abcdEFGH012345678
    token: Token123456
    renderAttachment: true
    timeout: 10s
    templateTitle: "{{ .Entry.Image }} released"
    templateBody: |
      Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
Name Default Description
endpoint1 Rocket.Chat base URL
channel1 Channel name with the prefix in front of it
userID1 User ID
token Authentication token
tokenFile Use content of secret file as authentication token if token not defined
renderAttachment true Render attachment object
timeout 10s Timeout specifies a time limit for the request to be made
templateTitle1 See below Notification template for message title
templateBody1 See below Notification template for message body

Warning

You must first create a Personal Access Token through your account settings on your Rocket.Chat instance. Additionally, your user must have the bot role. Else, the notifications won't work since they contain alias and avatar properties (see this reference for details).

Environment variables

  • DIUN_NOTIF_ROCKETCHAT_ENDPOINT
  • DIUN_NOTIF_ROCKETCHAT_CHANNEL
  • DIUN_NOTIF_ROCKETCHAT_USERID
  • DIUN_NOTIF_ROCKETCHAT_TOKEN
  • DIUN_NOTIF_ROCKETCHAT_TOKENFILE
  • DIUN_NOTIF_ROCKETCHAT_RENDERATTACHMENT
  • DIUN_NOTIF_ROCKETCHAT_TIMEOUT
  • DIUN_NOTIF_ROCKETCHAT_TEMPLATETITLE
  • DIUN_NOTIF_ROCKETCHAT_TEMPLATEBODY

Default templateTitle

{{ .Entry.Image }} {{ if (eq .Entry.Status "new") }}is available{{ else }}has been updated{{ end }}

Default templateBody

Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been {{ if (eq .Entry.Status "new") }}newly added{{ else }}updated{{ end }} on {{ .Meta.Hostname }}.

Sample


  1. Value required 


Last update: 2022-12-29 06:52:05
Created: 2020-06-19 22:47:17