CONNECT APP
Build with Metabase
Data Analytics
- API key
MCP
Give your agent Metabase tools
Every Metabase action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Metabase account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "metabase",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Dashboard:
const result = await mcp.callTool({
name: "metabase-create-dashboard",
arguments: {
name: "Name",
description: "Description",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "metabase",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Create Dashboard:
result = await session.call_tool("metabase-create-dashboard", {
"name": "Name",
"description": "Description",
})API PROXY
Call the Metabase API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Metabase API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.example.com/v1/me",
})
// Any allowed Metabase endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Metabase actions from your backend
Connect a user's Metabase account once, then run Create Dashboard on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "metabase-create-dashboard",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
metabase: { authProvisionId: "apn_xxxxxxx" },
name: "Name",
description: "Description",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="metabase-create-dashboard",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"metabase": {"authProvisionId": "apn_xxxxxxx"},
"name": "Name",
"description": "Description",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "metabase-create-dashboard",
"configured_props": {
"metabase": { "authProvisionId": "apn_xxxxxxx" },
"name": "Name",
"description": "Description"
}
}'TOOLS
Metabase actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Dashboard
actionCreate a new Dashboard. See the documentation.Writev0.0.4 -
Export Query with Format
actionExecute a saved question/card with parameters and export results in the specified format (CSV, JSON, XLSX, or API). See the documentation.Read-onlyv0.0.1 -
Get Dashboard
actionRetrieve dashboard information and its cards. See the documentation.Read-onlyv0.0.4 -
Get Database
actionRetrieve database information. See the documentation.Read-onlyv0.0.4 -
List Card ID Options
actionRetrieves available options for the Card ID field.Read-onlyv0.0.1 -
List Collection ID Options
actionRetrieves available options for the Collection ID field.Read-onlyv0.0.1 -
Run Query
actionExecute a saved question/card and return the results. See the documentation.Writev0.0.4
EVENTS
Metabase triggers
Event sources your backend can deploy for users and receive through a webhook.
No Metabase triggers are available yet.
MULTI-APP
Use Metabase with other popular apps
Most products don't stop at one integration. Pair Metabase with the other apps your users rely on, and ship use cases that span both.
- App slug
- metabase
- Authentication
- API key
- Categories
- Data Analytics
- Actions
- 7
- Triggers
- 0
- API proxy
- Available