Skip to content

Conversation

@nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Nov 30, 2025

Summary

Fixes #4027 by adding docs for the new email notification fields that were added for scheduled reports.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Preview

@github-actions
Copy link

github-actions bot commented Nov 30, 2025

✅ Vale Linting Results

No issues found on modified lines!

@github-actions
Copy link

github-actions bot commented Nov 30, 2025

🔍 Preview links for changed docs

* **Message**: Keep the default email message, or enter your own.
::::{note}
In the subject and message, you can use the [Mustache](https://mustache.github.io/mustache.5.html) template syntax (`{{variable name}}`) to dynamically pass values from data sources when the email is generated.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@umbopepato we may need to define the list of variables that users can select for the email subject and message, especially if they're not clearly defined in the UI.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooo good question. @umbopepato can you help with this question? ^

Copy link
Member

@umbopepato umbopepato Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@umbopepato we may need to define the list of variables that users can select for the email subject and message, especially if they're not clearly defined in the UI.

Variables are listed, with descriptions, in the picker just above the subject and message fields. In case we want to list the available vars in the docs as well, here's the data model we use to render the picker.

Does this also apply? https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts/rule-action-variables#enhance-mustache-variables

Good point @bmorelli25! Yes, we're using the same Mustache rendering functions as in actions, so the same lambdas are available.

@nastasha-solomon shall we specify that the message field also supports Markdown? It has implications on how Mustache is compiled, since a dedicated escape strategy is used.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shall we specify that the message field also supports Markdown? It has implications on how Mustache is compiled, since a dedicated escape strategy is used.

Yes! Can you share the method of escaping markdown in mustache templates?

@nastasha-solomon nastasha-solomon marked this pull request as ready for review November 30, 2025 18:39
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner November 30, 2025 18:39
Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple minor edits! Otherwise copy edit LGTM

nastasha-solomon and others added 2 commits December 1, 2025 17:47
Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
Copy link
Member

@umbopepato umbopepato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Team:Experience Issues owned by the Experience Docs Team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Internal]: Scheduled reports new email fields and Mustache support

5 participants