Get Involved
Edit on GitHub

message

Use the message step to send a one-way notification message from your pipeline.

When you run a pipeline in client-mode, notifications for message steps will only appear on the command line.

In server-mode, notifications for message steps are not sent to the console. Instead, they are sent to integrations such as Slack or Email via a notifier, allowing you to create collaborative workflows that integrate with your preferred communication channels.

pipeline "send_message" {
step "message" "send_a_message" {
notifier = notifier.default
channel = "#ops"
to = ["ops@bluth.com"]
subject = "Sample message"
text = "I'm a sample message."
}
}

Arguments

ArgumentTypeOptional?Description
textStringRequiredThe message text to send to the integration.
notifierNotifier ReferenceRequiredThe notifier to send the request to send the message.
ccList<String>OptionalThe email addresses to send to. This only applies to email integrations.
bccList<String>OptionalThe email addresses to send to. This only applies to notifiers that uses email integrations.
channelStringOptionalThe channel to send the request to. This only applies to slack integrations.
subjectStringOptionalThe email subject. This only applies to notifiers that uses email integrations.
toList<String>OptionalThe email addresses to send to. This only applies to email integrations.

This step also supports the common step arguments and attributes.