Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Auto-update documentation for master (#71058)

github-automation-metabase3bfd0aa9bf28
diff --git a/docs/api.json b/docs/api.json
index e296b2209ab..d5d11dd9748 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -3021,21 +3021,49 @@
"properties" : { }
} ]
},
- "metabase-enterprise.metabot-v3.tools.api.create-dashboard-subscription-arguments" : {
+ "metabase-enterprise.metabot-v3.tools.api.create-alert-arguments" : {
"allOf" : [ {
"type" : "object",
"properties" : {
- "dashboard_id" : {
+ "card_id" : {
"type" : "integer"
},
- "email" : {
+ "schedule" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.subscription-schedule"
+ },
+ "send_condition" : {
+ "type" : "string",
+ "enum" : [ "has_result", "goal_above", "goal_below" ]
+ },
+ "send_once" : {
+ "default" : false,
+ "type" : "boolean"
+ },
+ "slack_channel" : {
"type" : "string"
+ }
+ },
+ "required" : [ "card_id", "send_condition", "schedule", "slack_channel" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase-enterprise.metabot-v3.tools.api.create-dashboard-subscription-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dashboard_id" : {
+ "type" : "integer"
},
"schedule" : {
"$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.subscription-schedule"
+ },
+ "slack_channel" : {
+ "type" : "string"
}
},
- "required" : [ "dashboard_id", "email", "schedule" ]
+ "required" : [ "dashboard_id", "slack_channel", "schedule" ]
}, {
"type" : "object",
"properties" : { }
@@ -3273,23 +3301,28 @@
"field_id" : {
"type" : "string"
},
- "statistics" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.statistics"
- }, {
- "type" : "null"
- } ]
- },
- "values" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : { }
- }, {
- "type" : "null"
- } ]
+ "value_metadata" : {
+ "type" : "object",
+ "properties" : {
+ "field_values" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "statistics" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.statistics"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
}
},
- "required" : [ "field_id" ]
+ "required" : [ "field_id", "value_metadata" ]
}
},
"required" : [ "structured_output" ]
@@ -3421,108 +3454,6 @@
"required" : [ "output" ]
} ]
},
- "metabase-enterprise.metabot-v3.tools.api.find-outliers-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "data_source" : {
- "allOf" : [ {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "query" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "type" : "integer"
- }
- },
- "required" : [ "database" ]
- },
- "query_id" : {
- "type" : "string"
- },
- "result_field_id" : {
- "type" : "string"
- }
- },
- "required" : [ "query", "result_field_id" ]
- }, {
- "type" : "object",
- "properties" : {
- "metric_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "metric_id" ]
- }, {
- "type" : "object",
- "properties" : {
- "report_id" : {
- "type" : "integer"
- },
- "result_field_id" : {
- "type" : "string"
- }
- },
- "required" : [ "report_id", "result_field_id" ]
- }, {
- "type" : "object",
- "properties" : {
- "result_field_id" : {
- "type" : "string"
- },
- "table_id" : {
- "type" : "string"
- }
- },
- "required" : [ "table_id", "result_field_id" ]
- } ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- }
- },
- "required" : [ "data_source" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.find-outliers-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "dimension" : { },
- "value" : {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "number"
- } ]
- }
- },
- "required" : [ "dimension", "value" ]
- }
- }
- },
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
- },
- "required" : [ "output" ]
- } ]
- },
"metabase-enterprise.metabot-v3.tools.api.full-metric" : {
"type" : "object",
"properties" : {
@@ -7356,13 +7287,6 @@
"metabase.legacy-mbql.schema..legacy-column-metadata.qualified-keys" : {
"type" : "object",
"properties" : {
- "qp.pivot/pivot-grouping?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
"metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
@@ -8082,13 +8006,6 @@
"default" : { },
"type" : "object",
"properties" : {
- "qp.pivot/pivot-grouping?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
"binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
@@ -8302,7 +8219,8 @@
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.SourceQuery"
},
"limit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.int-greater-than-or-equal-to-zero"
+ "type" : "integer",
+ "minimum" : 0
},
"filter" : {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Filter"
@@ -9060,13 +8978,6 @@
"allOf" : [ {
"type" : "object",
"properties" : {
- "qp.pivot/pivot-grouping?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
"metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
@@ -9848,7 +9759,8 @@
"$ref" : "#/components/schemas/metabase.lib.schema.filters"
},
"limit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.int-greater-than-or-equal-to-zero"
+ "type" : "integer",
+ "minimum" : 0
},
"joins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.joins"
@@ -10031,11 +9943,6 @@
"metabase.lib.schema.common.base-type" : {
"type" : "string"
},
- "metabase.lib.schema.common.int-greater-than-or-equal-to-zero" : {
- "description" : "Schema representing an integer than must also be greater than or equal to zero.",
- "type" : "integer",
- "minimum" : 0
- },
"metabase.lib.schema.common.kebab-cased-map" : { },
"metabase.lib.schema.common.non-blank-string" : {
"type" : "string",
@@ -10109,11 +10016,13 @@
"properties" : {
"max-results" : {
"description" : "Maximum number of results to allow for a query with aggregations. If `max-results-bare-rows` is unset, this\n applies to all queries",
- "$ref" : "#/components/schemas/metabase.lib.schema.common.int-greater-than-or-equal-to-zero"
+ "type" : "integer",
+ "minimum" : 0
},
"max-results-bare-rows" : {
"description" : "Maximum number of results to allow for a query with no aggregations. If set, this should be LOWER than\n `:max-results`.",
- "$ref" : "#/components/schemas/metabase.lib.schema.common.int-greater-than-or-equal-to-zero"
+ "type" : "integer",
+ "minimum" : 0
}
}
},
@@ -10418,7 +10327,7 @@
"metabase.lib.schema.info.context" : {
"description" : "Schema for `info.context`; used for informational purposes to record how a query was executed.",
"type" : "string",
- "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "transform-inspector" ]
+ "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "transform-inspector", "slackbot" ]
},
"metabase.lib.schema.info.hash" : {
"type" : "string",
@@ -11112,13 +11021,6 @@
"type" : "null"
} ]
},
- "qp.pivot/pivot-grouping?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
"metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
@@ -11623,13 +11525,6 @@
"type" : "null"
} ]
},
- "qp.pivot/pivot-grouping?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
"metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
@@ -12313,13 +12208,6 @@
"default" : { },
"type" : "object",
"properties" : {
- "qp.pivot/pivot-grouping?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
"binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
@@ -12402,13 +12290,6 @@
"default" : { },
"type" : "object",
"properties" : {
- "qp.pivot/pivot-grouping?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
"binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
@@ -29366,11 +29247,85 @@
"tags" : [ "/api/ee/metabot-tools" ]
}
},
+ "/api/ee/metabot-tools/create-alert" : {
+ "post" : {
+ "operationId" : "post-api-ee-metabot-tools-create-alert",
+ "summary" : "POST /api/ee/metabot-tools/create-alert",
+ "description" : "Create an alert for a saved question.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "error" : {
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.create-alert-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/metabot-tools" ]
+ }
+ },
"/api/ee/metabot-tools/create-dashboard-subscription" : {
"post" : {
"operationId" : "post-api-ee-metabot-tools-create-dashboard-subscription",
"summary" : "POST /api/ee/metabot-tools/create-dashboard-subscription",
- "description" : "Create a dashboard subscription.",
+ "description" : "Create a dashboard subscription and send it to a slack channel.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -29386,7 +29341,7 @@
"type" : "string",
"pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "output" : {
+ "error" : {
"type" : "string"
},
"profile_id" : {
@@ -29397,7 +29352,7 @@
} ]
}
},
- "required" : [ "output", "conversation_id" ]
+ "required" : [ "conversation_id" ]
}
}
}
@@ -29515,7 +29470,7 @@
"post" : {
"operationId" : "post-api-ee-metabot-tools-filter-records",
"summary" : "POST /api/ee/metabot-tools/filter-records",
- "description" : "Construct a query from a metric.",
+ "description" : "Apply filters to records from a data source (query, report, or table).",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -29582,77 +29537,6 @@
"tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/metabot-tools/find-outliers" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-find-outliers",
- "summary" : "POST /api/ee/metabot-tools/find-outliers",
- "description" : "Find outliers in the values provided by a data source for a given column.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.find-outliers-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
"/api/ee/metabot-tools/generate-insights" : {
"post" : {
"operationId" : "post-api-ee-metabot-tools-generate-insights",
@@ -30994,6 +30878,13 @@
"type" : "string",
"pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
+ "debug" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"history" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.client.schema.messages"
@@ -31065,6 +30956,114 @@
"tags" : [ "/api/ee/metabot-v3/document" ]
}
},
+ "/api/ee/metabot-v3/document/native-generate-content" : {
+ "post" : {
+ "operationId" : "post-api-ee-metabot-v3-document-native-generate-content",
+ "summary" : "POST /api/ee/metabot-v3/document/native-generate-content",
+ "description" : "Create a new piece of content to insert into the document using the native Clojure agent.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "draft_card" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "dataset_query" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "name", "dataset_query", "database_id", "parameters", "visualization_settings" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "error" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "draft_card", "error", "description" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "instructions" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "references" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "instructions" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/metabot-v3/document" ]
+ }
+ },
"/api/ee/metabot-v3/feedback" : {
"post" : {
"operationId" : "post-api-ee-metabot-v3-feedback",
@@ -31333,6 +31332,188 @@
"tags" : [ "/api/ee/metabot-v3/metabot" ]
}
},
+ "/api/ee/metabot-v3/slack/events" : {
+ "post" : {
+ "operationId" : "post-api-ee-metabot-v3-slack-events",
+ "summary" : "POST /api/ee/metabot-v3/slack/events",
+ "description" : "Respond to activities in Slack",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "string"
+ },
+ "headers" : {
+ "type" : "object",
+ "properties" : {
+ "Content-Type" : {
+ "const" : "text/plain"
+ }
+ },
+ "required" : [ "Content-Type" ]
+ },
+ "status" : {
+ "const" : 200
+ }
+ },
+ "required" : [ "status", "headers", "body" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "challenge" : {
+ "type" : "string"
+ },
+ "type" : {
+ "const" : "url_verification"
+ }
+ },
+ "required" : [ "type", "challenge" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "event" : {
+ "type" : "object",
+ "properties" : {
+ "event_ts" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "event_ts" ]
+ },
+ "type" : {
+ "const" : "event_callback"
+ }
+ },
+ "required" : [ "type", "event" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type" ]
+ } ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/metabot-v3/slack" ]
+ }
+ },
+ "/api/ee/metabot-v3/slack/interactive" : {
+ "post" : {
+ "operationId" : "post-api-ee-metabot-v3-slack-interactive",
+ "summary" : "POST /api/ee/metabot-v3/slack/interactive",
+ "description" : "Handle interactive payloads from Slack (button clicks, modal submissions).",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/metabot-v3/slack" ]
+ }
+ },
+ "/api/ee/metabot-v3/slack/settings" : {
+ "put" : {
+ "operationId" : "put-api-ee-metabot-v3-slack-settings",
+ "summary" : "PUT /api/ee/metabot-v3/slack/settings",
+ "description" : "Update Metabot Slack settings atomically.\n All credential fields must be provided together.\n Setting values requires the metabot-v3 feature, but clearing values is always allowed.\n slack-connect-enabled is automatically set to true when credentials are provided, nil when cleared.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "ok" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "ok" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "metabot-slack-signing-secret" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "slack-connect-client-id" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "slack-connect-client-secret" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "slack-connect-client-id", "slack-connect-client-secret", "metabot-slack-signing-secret" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/metabot-v3/slack" ]
+ }
+ },
"/api/ee/permission_debug" : {
"get" : {
"operationId" : "get-api-ee-permission_debug",
@@ -40204,7 +40385,14 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.FullyHydratedNotification"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -45015,6 +45203,88 @@
"tags" : [ "/api/setup" ]
}
},
+ "/api/slack/app-info" : {
+ "get" : {
+ "operationId" : "get-api-slack-app-info",
+ "summary" : "GET /api/slack/app-info",
+ "description" : "Returns the Slack app_id and team_id. Used by the frontend to construct\n direct links to the Slack app settings page.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "app_id" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "scopes" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "actual" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "extra" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "missing" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "required" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "required" : [ "actual", "required", "missing", "extra" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "team_id" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "app_id", "team_id", "scopes" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/slack" ]
+ }
+ },
"/api/slack/bug-report" : {
"post" : {
"operationId" : "post-api-slack-bug-report",
@@ -45054,11 +45324,165 @@
"get" : {
"operationId" : "get-api-slack-manifest",
"summary" : "GET /api/slack/manifest",
- "description" : "Returns the YAML manifest file that should be used to bootstrap new Slack apps",
+ "description" : "Returns the JSON manifest file that should be used to bootstrap new Slack apps",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "display_information" : {
+ "type" : "object",
+ "properties" : {
+ "background_color" : {
+ "type" : "string"
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "description", "background_color" ]
+ },
+ "features" : {
+ "type" : "object",
+ "properties" : {
+ "app_home" : {
+ "type" : "object",
+ "properties" : {
+ "home_tab_enabled" : {
+ "type" : "boolean"
+ },
+ "messages_tab_enabled" : {
+ "type" : "boolean"
+ },
+ "messages_tab_read_only_enabled" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "home_tab_enabled", "messages_tab_enabled", "messages_tab_read_only_enabled" ]
+ },
+ "assistant_view" : {
+ "type" : "object",
+ "properties" : {
+ "assistant_description" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "assistant_description" ]
+ },
+ "bot_user" : {
+ "type" : "object",
+ "properties" : {
+ "always_online" : {
+ "type" : "boolean"
+ },
+ "display_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "display_name" ]
+ },
+ "slash_commands" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "command" : {
+ "type" : "string"
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "should_escape" : {
+ "type" : "boolean"
+ },
+ "url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "command", "url", "description", "should_escape" ]
+ }
+ }
+ },
+ "required" : [ "bot_user" ]
+ },
+ "oauth_config" : {
+ "type" : "object",
+ "properties" : {
+ "redirect_urls" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "scopes" : {
+ "type" : "object",
+ "properties" : {
+ "bot" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "required" : [ "bot" ]
+ }
+ },
+ "required" : [ "scopes" ]
+ },
+ "settings" : {
+ "type" : "object",
+ "properties" : {
+ "event_subscriptions" : {
+ "type" : "object",
+ "properties" : {
+ "bot_events" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "request_url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "request_url", "bot_events" ]
+ },
+ "interactivity" : {
+ "type" : "object",
+ "properties" : {
+ "is_enabled" : {
+ "type" : "boolean"
+ },
+ "request_url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "is_enabled", "request_url" ]
+ },
+ "org_deploy_enabled" : {
+ "type" : "boolean"
+ },
+ "socket_mode_enabled" : {
+ "type" : "boolean"
+ },
+ "token_rotation_enabled" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "event_subscriptions", "interactivity", "org_deploy_enabled", "socket_mode_enabled", "token_rotation_enabled" ]
+ }
+ },
+ "required" : [ "display_information", "features", "oauth_config" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index 2aa619ab999..558d6b33e64 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -203,6 +203,7 @@ config:
login-page-illustration: default
login-page-illustration-custom: null
map-tile-server-url: https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
+ metabot-slack-signing-secret: null
native-query-autocomplete-match-style: substring
nested-field-columns-value-length-limit: 50000
no-data-illustration: default
@@ -277,7 +278,7 @@ config:
slack-app-token: null
slack-bug-report-channel: metabase-bugs
slack-connect-attribute-team-id: https://slack.com/team_id
- slack-connect-authentication-mode: sso
+ slack-connect-authentication-mode: link-only
slack-connect-client-id: null
slack-connect-client-secret: null
slack-connect-enabled: false
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 7ea2c7fc690..1cd73824c54 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -1205,6 +1205,16 @@ The custom illustration for the login page.
The map tile server URL template used in map visualizations, for example from OpenStreetMaps or MapBox.
+### `MB_METABOT_SLACK_SIGNING_SECRET`
+
+> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
+
+- Type: string
+- Default: `null`
+- [Configuration file name](./config-file.md): `metabot-slack-signing-secret`
+
+Signing secret for verifying requests from the Metabot Slack app.
+
### `MB_NATIVE_QUERY_AUTOCOMPLETE_MATCH_STYLE`
- Type: keyword
@@ -1902,10 +1912,10 @@ Slack OIDC claim for the team/workspace ID.
> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
- Type: string
-- Default: `sso`
+- Default: `link-only`
- [Configuration file name](./config-file.md): `slack-connect-authentication-mode`
-Controls whether Slack can be used for SSO login or just account linking. Valid values: "sso" (default) or "link-only".
+Controls whether Slack can be used for SSO login or just account linking. Valid values: "sso" or "link-only" (default).
### `MB_SLACK_CONNECT_CLIENT_ID`