Knowledge

How to use email and SMS notifications?

You can use Buddy to send customized messages after completed actions to keep your team notified of the progress: just create a new Pipeline and add the Email or the SMS action to the list.

The Subject and Content areas are processed with the syntax of the Velocity Template Engine. The model of execution is the same that we use in our external API. It is described in detail in the pipelines/executions resource of the API documentation.

Example email parameters
Example email parameters

However, the syntax itself is pretty simple and based on variables with telling names. For example using ${execution.creator.name} in the field will generate the name of the person who started the execution, while using $execution.action_executions[0] will produce results for the first action in the pipeline.

Notification parameters

Here's a list of common parameters that you can use in your messages:

${workspace.html_url}
${workspace.name}
${workspace.domain}
${invoker.name}
${invoker.email}
${project.html_url}
${project.name}
${project.display_name}
${project.repository_type}
${execution.id}
${execution.html_url}
${execution.start_date}
${execution.mode}
${execution.refresh}
${execution.status}
${execution.comment}
${execution.pipeline.html_url}
${execution.pipeline.name}

You can find the full list of parameters here.

Get started now

14 days of unlimited trial. No credit card required.