AlertmanagerConfig.spec.receivers[].rocketchatConfigs[]
RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0.
| Field / Type | Description |
|---|---|
actions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses.
| |
apiURL | apiURL defines the API URL for RocketChat. Defaults to https://open.rocket.chat/ if not specified.
|
channel | channel defines the channel to send alerts to. This can be a channel name (e.g., "#alerts") or a direct message recipient.
|
color | color defines the message color displayed in RocketChat. This appears as a colored bar alongside the message.
|
emoji | emoji defines the emoji to be displayed as an avatar. If provided, this emoji will be used instead of the default avatar or iconURL.
|
fields defines additional fields for the message attachment. These appear as structured key-value pairs within the message.
| |
httpConfig defines the HTTP client configuration for RocketChat API requests. | |
iconURL | iconURL defines the icon URL for the message avatar. This displays a custom image as the message sender's avatar. |
imageURL | imageURL defines the image URL to display within the message. This embeds an image directly in the message attachment. |
linkNames | linkNames defines whether to enable automatic linking of usernames and channels. When true, @username and #channel references become clickable links. |
sendResolved | sendResolved defines whether or not to notify about resolved alerts. |
shortFields | shortFields defines whether to use short fields in the message layout. When true, fields may be displayed side by side to save space. |
text | text defines the message text to send. This is optional because attachments can be used instead of or alongside text.
|
thumbURL | thumbURL defines the thumbnail URL for the message. This displays a small thumbnail image alongside the message content. |
title | title defines the message title displayed prominently in the message. This appears as bold text at the top of the message attachment.
|
titleLink | titleLink defines the URL that the title will link to when clicked. This makes the message title clickable in the RocketChat interface.
|
token defines the sender token for RocketChat authentication. This is the personal access token or bot token used to authenticate API requests. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
| |
tokenID defines the sender token ID for RocketChat authentication. This is the user ID associated with the token used for API requests. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
|