Rocket.Chat

The rocketchat trigger lets you post image update notifications to a Rocket.Chat channel or user.

logo

The rocketchat trigger lets you post image update notifications to a Rocket.Chat channel or user.

Variables

Env var	Required	Description	Supported values	Default value when missing
`DD_TRIGGER_ROCKETCHAT_{trigger_name}_URL`	🔴	Rocket.Chat workspace URL, e.g. `https://example.com`.
`DD_TRIGGER_ROCKETCHAT_{trigger_name}_USER_ID`	🔴	User id of the user sending the notification. Displayed when generating a personal access token (PAT).
`DD_TRIGGER_ROCKETCHAT_{trigger_name}_AUTH_TOKEN`	🔴	PAT of the user sending the notification.
`DD_TRIGGER_ROCKETCHAT_{trigger_name}_CHANNEL`	🔴	Where the message is sent to.	Channel ID (`6561ce603d237c33797650d7`), channel name (`#example`) or username (`@example`).
`DD_TRIGGER_ROCKETCHAT_{trigger_name}_ALIAS`	⚪	Alters the sender's name shown for the message, but keeps the username as is. Requires `message-impersonate` permission, typically only present on the `bot` role.
`DD_TRIGGER_ROCKETCHAT_{trigger_name}_AVATAR`	⚪	Display the sender's avatar as the provided image URL. Requires `message-impersonate` permission, typically only on the `bot` role.
`DD_TRIGGER_ROCKETCHAT_{trigger_name}_EMOJI`	⚪	Display the sender's avatar as an emoji, e.g. `:smile:`.
`DD_TRIGGER_ROCKETCHAT_{trigger_name}_PARSE_URLS`	⚪	Whether Rocket.Chat should generate link previews when the message text contains URLs. Enabled by default.	`true`, `false`
`DD_TRIGGER_ROCKETCHAT_{trigger_name}_DISABLETITLE`	⚪	Disable title to have full control over the message formatting.	`true`, `false`	`false`

The Rocket.Chat channel must already exist on the workspace (the trigger won't automatically create it)

This trigger also supports the common configuration variables.

See also the Rocket.Chat API documentation for additional information.

Examples

services:
  drydock:
    image: codeswhat/drydock
    ...
    environment:
        - DD_TRIGGER_ROCKETCHAT_LOCAL_URL=https://example.com
        - DD_TRIGGER_ROCKETCHAT_LOCAL_USER_ID=jDdn8oh9BfJKnWdDY
        - DD_TRIGGER_ROCKETCHAT_LOCAL_AUTH_TOKEN=Rbqz90hnkRyVwRfcmE5PzkP5Pqwml_fo7ZUXzxv2_zx
        - DD_TRIGGER_ROCKETCHAT_LOCAL_CHANNEL=#drydock

docker run \
    -e DD_TRIGGER_ROCKETCHAT_LOCAL_URL="https://example.com" \
    -e DD_TRIGGER_ROCKETCHAT_LOCAL_USER_ID="jDdn8oh9BfJKnWdDY" \
    -e DD_TRIGGER_ROCKETCHAT_LOCAL_AUTH_TOKEN="Rbqz90hnkRyVwRfcmE5PzkP5Pqwml_fo7ZUXzxv2_zx" \
    -e DD_TRIGGER_ROCKETCHAT_LOCAL_CHANNEL="#drydock" \
  ...
  codeswhat/drydock

How to obtain the sender's user ID and auth token

Log in to your Rocket.Chat workspace with the sender's account
Click on your profile picture in the top left corner, then click on "Profile"
Click on "Personal Access Tokens" in the left menu
Type a name for the token, select "Ignore Two Factor Authentication" and click on "Add"
Confirm your password or 2FA code
Copy the user ID and auth token values

Rocket.Chat

Variables

Examples

How to obtain the sender's user ID and auth token

On this page