Metabase Dashboards Trigger

Metabase Dashboards Trigger

Certified

Metabase dashboard polling trigger

Triggers a flow when a Metabase dashboard is created or updated since the last evaluation. The watermark is kept in the namespace KV store.

yaml
type: io.kestra.plugin.metabase.dashboards.Trigger

Watch for dashboard changes in Metabase and trigger a flow

yaml
id: on_metabase_change
namespace: company.team

triggers:
  - id: watch
    type: io.kestra.plugin.metabase.dashboards.Trigger
    url: "{{ secret('METABASE_URL') }}"
    apiKey: "{{ secret('METABASE_API_KEY') }}"
    interval: PT5M

tasks:
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: "Metabase dashboard change detected. Changed count: {{ trigger.size }}"
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-metabase --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

Properties

Metabase server URL

Base URL of the Metabase instance, for example https://metabase.example.com or http://localhost: 3000.

Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

Metabase API key

API key sent in the x-api-key header. Requires Metabase v0.47 or later. Set exactly one authentication mode: apiKey, sessionToken, or both username and password.

DefaultPT5M
Formatduration

Polling interval

The interval between polling checks. Defaults to 5 minutes.

Defaultfalse

Trigger on startup

If true, the first evaluation fires for all existing dashboards. If false (default), the first evaluation only records the watermark without firing.

Metabase password

Password used to open a session through POST /api/session. Must be set together with username.

DefaultPT1M

HTTP request timeout

Connect and read timeout for each HTTP request made to Metabase. Defaults to 60 seconds.

Metabase session token

Session token sent in the X-Metabase-Session header. Set exactly one authentication mode: apiKey, sessionToken, or both username and password.

SubTypestring
Possible Values
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

Metabase username

Username or email used to open a session through POST /api/session. Must be set together with password. The session is closed with DELETE /api/session when the evaluation ends.

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

SubTypeobject

Dashboards

The Metabase dashboards returned by the task, or the ones created or updated since the last evaluation for the trigger.

Dashboards count

Number of dashboards in dashboards.