The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
docs - embedded alerts (#69201)
Jeff Bruemmer8e33138cafab
diff --git a/docs/embedding/components.md b/docs/embedding/components.mdindex 4e49951c681..bc8563866ac 100644--- a/docs/embedding/components.md+++ b/docs/embedding/components.md@@ -87,7 +87,8 @@ To render a question (chart):- `with-downloads` (default is true on OSS/Starter and false on Pro/Enterprise) - show downloads- `initial-sql-parameters` - default value for SQL parameters, only applicable to native SQL questions, like `{ "productId": "42" }`- `is-save-enabled` (default is false)-- `target-collection` - this is to enforce saving into a particular collection. Values: regular ID, entity ID, `"personal”`, `"root”`+- `target-collection` - this is to enforce saving into a particular collection. Values: regular ID, entity ID, `"personal"`, `"root"`+- `with-alerts` (default is false) - let people set up [alerts](../questions/alerts.md) on embedded questions. Requires [email setup](../configuring-metabase/email.md). Unlike alerts on non-embedded questions, alerts on embedded questions only send to the logged-in user and exclude links to Metabase items. Not available for models.Only `with-title` and `with-downloads` are supported in [guest embeds](./guest-embedding.md).diff --git a/docs/embedding/modular-embedding.md b/docs/embedding/modular-embedding.mdindex 5b5222450ef..951ee0a904f 100644--- a/docs/embedding/modular-embedding.md+++ b/docs/embedding/modular-embedding.md@@ -171,6 +171,7 @@ When you're creating a new embed using **Admin > Embedding > Setup guide > Embed- **Allow editing dashboards and questions**: lets people create and edit dashboards or questions in the current collection. When disabled, they can still perform actions like filter, summarize, and drill-through, but won't be able to save results.+- **Allow alerts**: lets people set up [alerts](../questions/alerts.md) on embedded questions. Requires [email setup](../configuring-metabase/email.md). Only for authenticated (SSO) question embeds.## Page-level configdiff --git a/docs/embedding/sdk/introduction.md b/docs/embedding/sdk/introduction.mdindex 7740e9eeb84..2cc4c567951 100644--- a/docs/embedding/sdk/introduction.md+++ b/docs/embedding/sdk/introduction.md@@ -118,8 +118,6 @@ The SDK doesn't support:- Verified content- Official collections-- Subscriptions-- Alerts- Click behavior with custom destinations to other items in the same Metabase (like to other questions or dashboards)- Server-side rendering (SSR)diff --git a/docs/embedding/sdk/questions.md b/docs/embedding/sdk/questions.mdindex 980804a7d98..60b9c23a0b7 100644--- a/docs/embedding/sdk/questions.md+++ b/docs/embedding/sdk/questions.md@@ -71,6 +71,16 @@ You can pass parameter values to questions defined with SQL via the `initialSqlP`initialSqlParameters` can't be used with questions built using the query builder.+## Enable alerts on embedded questions++You can let people set up [alerts](../../questions/alerts.md) on embedded questions by passing the `withAlerts` prop to `StaticQuestion` or `InteractiveQuestion`. Alerts require [email setup](../../configuring-metabase/email.md), and the question must be saved (not a new question).++Alerts created in an embedded context only send to the logged-in user and exclude links to Metabase items.++```tsx+<StaticQuestion questionId={42} withAlerts />+```+## Questions with natural languageSee [AI chat](./ai-chat.md).diff --git a/docs/questions/alerts.md b/docs/questions/alerts.mdindex 0d0bd0e742b..6e0e5440a7f 100644--- a/docs/questions/alerts.md+++ b/docs/questions/alerts.md@@ -156,6 +156,10 @@ See [Sending alerts and subscriptions to private Slack channels](../configuring-See [Remove Metabase branding from exports](./exporting-results.md#remove-metabase-branding-from-exports).+## Alerts in embedded questions exclude links++Since people viewing embedded questions likely don't have direct access to your Metabase, Metabase omits links to Metabase items in alerts sent from embedded questions. That way people don't get broken links in their email.+## Further reading- [Dashboard subscriptions](../dashboards/subscriptions.md)