Grafana
Connect Grafana alerts, alert rules, dashboards, annotations, silences, and data queries to SuperPlane workflows
Triggers
Section titled “Triggers”Actions
Section titled “Actions”Instructions
Section titled “Instructions”Setup steps:
-
In Grafana, go to Administration → Users and access → Service Accounts, select Add service account.
Service Account Role:
While naming the service account, go to Roles → Basic roles and select Admin.Navigate to the created service account and select Add service account token. Name it and set an expiration period then click Generate token. This is your Service Account Token.
-
Use your Grafana root URL as Base URL (for example
https://grafana.example.com). -
Fill in Base URL and Service Account Token below, then save.
On Alert Firing
Section titled “On Alert Firing”The On Alert Firing trigger starts a workflow when Grafana Unified Alerting sends a firing alert webhook.
- SuperPlane automatically creates or updates a Grafana Webhook contact point and notification policy route for this trigger when provisioning succeeds.
- SuperPlane manages webhook bearer authentication automatically.
- Provisioning requires a Grafana integration with Base URL and Service Account Token and sufficient permissions for alerting and provisioning APIs.
Configuration
Section titled “Configuration”- Alert Names: Optional exact alert name filters
Event Data
Section titled “Event Data”The trigger emits the full Grafana webhook payload, including:
- status (firing/resolved)
- alerts array with labels and annotations
- groupLabels, commonLabels, commonAnnotations
- externalURL and other alerting metadata
Example Data
Section titled “Example Data”{ "data": { "alerts": [ { "annotations": { "summary": "Error rate above threshold" }, "labels": { "alertname": "HighErrorRate", "service": "api" }, "status": "firing" } ], "commonLabels": { "alertname": "HighErrorRate" }, "externalURL": "http://grafana.local", "ruleUid": "alert_rule_uid", "status": "firing", "title": "High error rate" }, "timestamp": "2026-02-12T16:18:03.362582388Z", "type": "grafana.alert.firing"}Create Alert Rule
Section titled “Create Alert Rule”The Create Alert Rule component creates a Grafana-managed alert rule using the Alerting Provisioning HTTP API.
Use Cases
Section titled “Use Cases”- Monitoring onboarding: create baseline alerts when a new service or environment is provisioned
- Incident automation: create temporary alert rules during an incident or validation workflow
- Policy rollout: standardize alert coverage across teams using a shared rule definition
Configuration
Section titled “Configuration”- Title: Human-readable alert name shown in Grafana
- Folder: Existing Grafana folder that should contain the rule
- Rule Group: Grafana rule group to create the rule in
- Data Source: Existing Grafana data source the query should use
- Query: Expression Grafana evaluates when checking the alert
- Lookback Window: How far back to query when evaluating the rule
- Reducer / Condition / Threshold(s): How the series is reduced, how it is compared to thresholds, and optional upper bound for range conditions
- For: How long the condition must hold before firing
- No Data / Execution Error State: Grafana behavior when the query returns no data or errors
- Contact Point: Optional Grafana contact point for notifications when the rule fires
- Labels / Annotations: Optional routing and context metadata attached to the rule
- Paused: Whether the rule starts paused
Output
Section titled “Output”Returns the created Grafana alert rule object, including identifiers and evaluation metadata.
Example Output
Section titled “Example Output”{ "data": { "annotations": { "summary": "High error rate detected" }, "condition": "C", "data": [ { "datasourceUid": "prometheus-main", "model": { "editorMode": "code", "expr": "sum(rate(http_requests_total{status=~\"5..\"}[5m]))", "intervalMs": 1000, "maxDataPoints": 43200, "query": "sum(rate(http_requests_total{status=~\"5..\"}[5m]))", "refId": "A" }, "queryType": "", "refId": "A", "relativeTimeRange": { "from": 300, "to": 0 } }, { "datasourceUid": "__expr__", "model": { "expression": "A", "id": "reduce", "reducer": "last", "refId": "B", "settings": { "mode": "dropNN" }, "type": "reduce" }, "queryType": "", "refId": "B", "relativeTimeRange": { "from": 0, "to": 0 } }, { "datasourceUid": "__expr__", "model": { "conditions": [ { "evaluator": { "params": [ 1 ], "type": "gt" }, "operator": { "type": "and" }, "query": { "params": [ "C" ] }, "reducer": { "type": "last" }, "type": "query" } ], "expression": "B", "id": "threshold", "refId": "C", "type": "threshold" }, "queryType": "", "refId": "C", "relativeTimeRange": { "from": 0, "to": 0 } } ], "execErrState": "Alerting", "folderUID": "infra", "for": "5m", "id": 42, "isPaused": false, "labels": { "service": "api", "severity": "critical" }, "noDataState": "NoData", "orgID": 1, "ruleGroup": "service-health", "title": "High error rate", "uid": "cergr5pm79hj4d", "updated": "2026-03-31T10:20:30Z" }, "timestamp": "2026-03-31T10:20:30Z", "type": "grafana.alertRule"}Create Annotation
Section titled “Create Annotation”The Create Annotation component writes an annotation into Grafana, marking operational events on dashboard timelines.
Use Cases
Section titled “Use Cases”- Deploy tracking: Annotate graphs at the exact moment a deployment is triggered or completes
- Incident markers: Place a marker when an incident is opened or resolved for post-incident correlation
- Maintenance windows: Mark the start and end of a maintenance window as a region annotation
- Change correlation: Record configuration changes, feature flag toggles, or rollbacks directly on the timeline
Configuration
Section titled “Configuration”- Dashboard: Optional — choose a dashboard from your Grafana instance to scope the annotation
- Panel: Required — choose the panel within the selected dashboard to attach the annotation to
- Text: The annotation message (required)
- Tags: Optional list of tags to label the annotation (e.g. deploy, rollback, incident)
- Time: Optional start time value. Examples:
{{ now() }}or{{ now() - duration("5m") }} - Time End: Optional end time value for a region annotation. Examples:
{{ now() }}or{{ now() + duration("24h") }}
Output
Section titled “Output”Returns the ID of the newly created annotation.
Example Output
Section titled “Example Output”{ "data": { "id": 42, "url": "https://grafana.example.com/d/production-overview/production-overview?from=1739376783362\u0026to=1739377383362" }, "timestamp": "2026-02-12T16:18:03.362582388Z", "type": "grafana.annotation.created"}Create Silence
Section titled “Create Silence”The Create Silence component creates a new Alertmanager silence in Grafana, suppressing alert notifications that match the configured matchers during the specified time window.
Use Cases
Section titled “Use Cases”- Deploy window: Suppress noisy alerts during a planned maintenance or deployment window
- Incident management: Prevent alert storms from flooding on-call channels while an incident is being worked on
- Testing: Silence alerts during load tests or chaos experiments
Configuration
Section titled “Configuration”- Matchers: One or more label matchers that identify which alerts to silence (required). Each matcher uses an operator: equal (=), not equal (!=), regex match (=
), or regex does not match (!), matching Grafana Alertmanager semantics. - Starts At: The start of the silence window (required)
- Ends At: The end of the silence window (required)
- Comment: A description of why the silence is being created (required)
- The createdBy field sent to Grafana is set automatically to SuperPlane-<org_name> and is not configurable
Output
Section titled “Output”Returns the ID of the newly created silence.
Example Output
Section titled “Example Output”{ "data": { "endsAt": "2026-04-01T10:24:30Z", "silenceId": "a3e5c2d1-8b4f-4e1a-9c7d-2f0e6b3a1d5c", "startsAt": "2026-03-31T10:24:30Z" }, "timestamp": "2026-03-31T10:24:30Z", "type": "grafana.silence.created"}Delete Alert Rule
Section titled “Delete Alert Rule”The Delete Alert Rule component deletes a Grafana-managed alert rule using the Alerting Provisioning HTTP API.
Use Cases
Section titled “Use Cases”- Alert cleanup: remove temporary or obsolete rules after a rollout or incident
- Service retirement: delete rules that are no longer needed when an environment is decommissioned
- Controlled cleanup: pair deletions with approvals, notifications, or audit workflows
Configuration
Section titled “Configuration”- Alert Rule: The Grafana alert rule to delete
Output
Section titled “Output”Returns a confirmation object with the deleted alert rule UID, title, and deletion status.
Example Output
Section titled “Example Output”{ "data": { "deleted": true, "title": "High error rate", "uid": "cergr5pm79hj4d" }, "timestamp": "2026-03-31T10:24:30Z", "type": "grafana.alertRuleDeleted"}Delete Annotation
Section titled “Delete Annotation”The Delete Annotation component removes an annotation from Grafana by ID.
Use Cases
Section titled “Use Cases”- Cleanup incorrect markers: Remove an annotation that was created with wrong text or tags
- Automated lifecycle: Delete temporary markers (e.g. maintenance window start) once the event is complete
- Idempotent workflows: Allow re-runs to clean up previously created annotations before re-creating them
Configuration
Section titled “Configuration”- Annotation: The annotation to delete, chosen from your Grafana instance (required)
Output
Section titled “Output”Returns the annotation ID and a confirmation that the annotation was deleted.
Example Output
Section titled “Example Output”{ "data": { "deleted": true, "id": 42 }, "timestamp": "2026-02-12T16:18:03.362582388Z", "type": "grafana.annotation.deleted"}Delete Silence
Section titled “Delete Silence”The Delete Silence component expires an existing silence in Grafana Alertmanager.
Use Cases
Section titled “Use Cases”- End a maintenance window early: Remove a silence once deployment or maintenance completes ahead of schedule
- Automated cleanup: Expire silences created by automation after the condition they covered has resolved
Configuration
Section titled “Configuration”- Silence: The silence to expire (required)
Output
Section titled “Output”Returns the silence ID and a confirmation that the silence was deleted.
Example Output
Section titled “Example Output”{ "data": { "deleted": true, "silenceId": "a3e5c2d1-8b4f-4e1a-9c7d-2f0e6b3a1d5c" }, "timestamp": "2026-03-31T10:24:30Z", "type": "grafana.silence.deleted"}Get Alert Rule
Section titled “Get Alert Rule”The Get Alert Rule component fetches a Grafana-managed alert rule using the Alerting Provisioning HTTP API.
Use Cases
Section titled “Use Cases”- Configuration review: inspect the current source of truth before changing a rule
- Workflow enrichment: include alert rule details in notifications, tickets, or approvals
- Drift checks: compare the current Grafana rule against an expected configuration
Configuration
Section titled “Configuration”- Alert Rule: The Grafana alert rule to retrieve
Output
Section titled “Output”Returns the full Grafana alert rule object, including title, folder, group, condition, queries, labels, and annotations.
Example Output
Section titled “Example Output”{ "data": { "annotations": { "summary": "High error rate detected" }, "condition": "C", "data": [ { "datasourceUid": "prometheus-main", "model": { "editorMode": "code", "expr": "sum(rate(http_requests_total{status=~\"5..\"}[5m]))", "intervalMs": 1000, "maxDataPoints": 43200, "query": "sum(rate(http_requests_total{status=~\"5..\"}[5m]))", "refId": "A" }, "queryType": "", "refId": "A", "relativeTimeRange": { "from": 300, "to": 0 } }, { "datasourceUid": "__expr__", "model": { "expression": "A", "id": "reduce", "reducer": "last", "refId": "B", "settings": { "mode": "dropNN" }, "type": "reduce" }, "queryType": "", "refId": "B", "relativeTimeRange": { "from": 0, "to": 0 } }, { "datasourceUid": "__expr__", "model": { "conditions": [ { "evaluator": { "params": [ 1 ], "type": "gt" }, "operator": { "type": "and" }, "query": { "params": [ "C" ] }, "reducer": { "type": "last" }, "type": "query" } ], "expression": "B", "id": "threshold", "refId": "C", "type": "threshold" }, "queryType": "", "refId": "C", "relativeTimeRange": { "from": 0, "to": 0 } } ], "execErrState": "Alerting", "folderUID": "infra", "for": "5m", "id": 42, "isPaused": false, "labels": { "service": "api", "severity": "critical" }, "noDataState": "NoData", "orgID": 1, "ruleGroup": "service-health", "title": "High error rate", "uid": "cergr5pm79hj4d", "updated": "2026-03-31T10:20:30Z" }, "timestamp": "2026-03-31T10:20:30Z", "type": "grafana.alertRule"}Get Dashboard
Section titled “Get Dashboard”The Get Dashboard component fetches a Grafana dashboard using the Grafana Dashboards HTTP API.
Use Cases
Section titled “Use Cases”- Dashboard inspection: retrieve current dashboard configuration for review or downstream use
- Workflow enrichment: include dashboard details in notifications, tickets, or approvals
- Panel discovery: list panels available in a dashboard for subsequent rendering or linking
Configuration
Section titled “Configuration”- Dashboard: The Grafana dashboard UID to retrieve
Output
Section titled “Output”Returns the Grafana dashboard object, including title, slug, URL, folder, tags, and panel summaries.
Example Output
Section titled “Example Output”{ "data": { "folder": "fdg4m1rt63hj8q", "folderTitle": "Platform", "panels": [ { "id": 1, "title": "Request Rate", "type": "timeseries" }, { "id": 2, "title": "Error Rate", "type": "timeseries" }, { "id": 3, "title": "P99 Latency", "type": "gauge" } ], "slug": "production-overview", "tags": [ "production", "platform" ], "title": "Production Overview", "uid": "cIBgcSjkk", "url": "https://grafana.example.com/d/cIBgcSjkk/production-overview" }, "timestamp": "2026-03-31T10:24:30Z", "type": "grafana.dashboard"}Get Silence
Section titled “Get Silence”The Get Silence component fetches the details of a single silence from Grafana Alertmanager using its ID.
Use Cases
Section titled “Use Cases”- Inspect a silence: Retrieve full details of a silence including state, comment, matchers, and times
- Verify a silence: Confirm a silence is still active before taking action in a workflow
Configuration
Section titled “Configuration”- Silence: The silence to retrieve (required)
Output
Section titled “Output”Returns the silence object including ID, state, comment, matchers, start/end times, and the author.
Example Output
Section titled “Example Output”{ "data": { "comment": "Deploy window for v2.1.0", "createdBy": "devops-bot", "endsAt": "2026-03-31T11:00:00.000Z", "id": "a3e5c2d1-8b4f-4e1a-9c7d-2f0e6b3a1d5c", "matchers": [ { "isEqual": true, "isRegex": false, "name": "env", "value": "production" } ], "startsAt": "2026-03-31T10:00:00.000Z", "status": { "state": "active" }, "updatedAt": "2026-03-31T10:00:00.000Z" }, "timestamp": "2026-03-31T10:24:30Z", "type": "grafana.silence"}List Alert Rules
Section titled “List Alert Rules”The List Alert Rules component lists Grafana-managed alert rules using the Alerting Provisioning HTTP API.
Use Cases
Section titled “Use Cases”- Alert audits: review which Grafana alert rules currently exist
- Workflow enrichment: send alert inventories to Slack, Jira, or documentation steps
- Follow-up automation: feed alert rule summaries into downstream review or cleanup workflows
Configuration
Section titled “Configuration”All fields are optional:
- Folder: When set, only alert rules in this Grafana folder are listed
- Rule Group: When set, only rules in this Grafana rule group are listed
When both are omitted, the component lists alert rules across the instance (subject to Grafana permissions).
Output
Section titled “Output”Returns an object containing the list of Grafana alert rule summaries, including each rule UID and title.
Example Output
Section titled “Example Output”{ "data": { "alertRules": [ { "title": "High error rate", "uid": "cergr5pm79hj4d" }, { "title": "High latency", "uid": "aer9k2pm71sh2b" }, { "title": "Service unavailable", "uid": "bfg4m1rt63hj8q" } ] }, "timestamp": "2026-03-31T10:24:30Z", "type": "grafana.alertRules"}List Annotations
Section titled “List Annotations”The List Annotations component retrieves annotations from Grafana, optionally filtered by tag, dashboard, or time range.
Use Cases
Section titled “Use Cases”- Audit operational events: Review recent deploy, incident, or change markers on a timeline
- Correlate incidents: Retrieve annotations from around an incident time window for post-incident analysis
- Workflow branching: Check for existing markers before creating duplicate annotations
Configuration
Section titled “Configuration”- Dashboard: Optional — filter to annotations on a specific dashboard from your Grafana instance
- Panel: Optional — filter to annotations on a specific panel within the selected dashboard
- Text: Optional — filter annotations whose text contains this value
- Tags: Filter to annotations matching all of the specified tags (optional)
- From / To: Time range filter values (optional). Examples:
{{ now() - duration("1h") }}and{{ now() }} - Limit: Maximum number of annotations to return (optional)
Output
Section titled “Output”Returns a list of annotation objects including ID, text, tags, time, and dashboard/panel references.
Example Output
Section titled “Example Output”{ "data": { "annotations": [ { "dashboardUID": "abc123", "id": 42, "panelId": 3, "tags": [ "deploy", "production" ], "text": "Deploy v1.2.3 to production", "time": 1739376000000, "timeEnd": 1739376000000, "type": "annotation" }, { "dashboardUID": "abc123", "id": 41, "panelId": 3, "tags": [ "rollback", "production" ], "text": "Rollback to v1.2.2", "time": 1739289600000, "timeEnd": 1739289600000, "type": "annotation" } ], "from": "2026-02-12T15:18:03.362582388Z", "to": "2026-02-12T16:18:03.362582388Z" }, "timestamp": "2026-02-12T16:18:03.362582388Z", "type": "grafana.annotations"}List Silences
Section titled “List Silences”The List Silences component retrieves silences from Grafana Alertmanager.
Use Cases
Section titled “Use Cases”- Audit: Review all currently active or pending silences in your Grafana instance
- Detect if already muted: Check whether a specific alert or label set is already silenced before creating a duplicate
- Workflow logic: Branch on silence state — e.g. skip escalation if an alert is already silenced
Configuration
Section titled “Configuration”- Filter: Optional label matcher string to filter silences (e.g.
alertname=~"High.*")
Output
Section titled “Output”Returns a list of silence objects, each including ID, state, comment, matchers, start/end times, and the author.
Example Output
Section titled “Example Output”{ "data": { "silences": [ { "comment": "Deploy window for v2.1.0", "createdBy": "devops-bot", "endsAt": "2026-03-31T11:00:00.000Z", "id": "a3e5c2d1-8b4f-4e1a-9c7d-2f0e6b3a1d5c", "matchers": [ { "isEqual": true, "isRegex": false, "name": "env", "value": "production" } ], "startsAt": "2026-03-31T10:00:00.000Z", "status": { "state": "active" }, "updatedAt": "2026-03-31T10:00:00.000Z" } ] }, "timestamp": "2026-03-31T10:24:30Z", "type": "grafana.silences"}Query Data Source
Section titled “Query Data Source”The Query Data Source component executes a query against a Grafana data source using the Grafana Query API.
Use Cases
Section titled “Use Cases”- Metrics investigation: Run PromQL or other datasource queries from workflows
- Alert validation: Validate alert conditions before escalation
- Incident context: Pull current metrics into incident workflows
Configuration
Section titled “Configuration”- Data Source: The Grafana data source to query
- Query: The datasource query (PromQL, InfluxQL, etc.)
- Time From / Time To: Optional expressions for the query range (for example
now() - duration("5m")andnow()) - Timezone: Interprets datetime-local expression results using the selected timezone offset
- If omitted, SuperPlane defaults the query to the last 5 minutes
- Format: Optional query format (depends on the datasource)
Output
Section titled “Output”Returns the Grafana query API response JSON.
Example Output
Section titled “Example Output”{ "data": { "results": { "A": { "frames": [ { "data": { "values": [ [ "2026-02-07T08:00:00Z", "2026-02-07T08:01:00Z" ], [ 1, 1 ] ] }, "schema": { "fields": [ { "name": "time", "type": "time" }, { "name": "value", "type": "number" } ] } } ] } } }, "timestamp": "2026-02-12T16:18:03.362582388Z", "type": "grafana.query.result"}Render Panel
Section titled “Render Panel”The Render Panel component constructs a Grafana image render URL for a dashboard panel using the Grafana Image Renderer.
Use Cases
Section titled “Use Cases”- Incident snapshots: attach or link a rendered panel image in tickets or notifications
- Scheduled reports: generate a reusable render URL for panel snapshots
- Workflow enrichment: pass a compact panel image URL through workflow steps
Configuration
Section titled “Configuration”- Dashboard: The Grafana dashboard containing the panel to render
- Panel: The panel to render
- Width: Image width in pixels (default 1000)
- Height: Image height in pixels (default 500)
- From: Optional start of the time range. Examples:
{{ now() - duration("1h") }}ornow-1h - To: Optional end of the time range. Examples:
{{ now() }}ornow
Output
Section titled “Output”Returns the Grafana render URL along with the dashboard UID and panel.
Example Output
Section titled “Example Output”{ "data": { "dashboard": "cIBgcSjkk", "panel": 2, "url": "https://grafana.example.com/render/d-solo/cIBgcSjkk/production-overview?panelId=2\u0026width=1000\u0026height=500\u0026tz=UTC" }, "timestamp": "2026-03-31T10:24:30Z", "type": "grafana.panel.image"}Update Alert Rule
Section titled “Update Alert Rule”The Update Alert Rule component updates a Grafana-managed alert rule using the Alerting Provisioning HTTP API.
Use Cases
Section titled “Use Cases”- Threshold tuning: refine alert conditions after incidents or noisy periods
- Ownership changes: update labels and annotations used for routing and context
- Rollout safety: adjust alert rules during migrations or environment transitions
Configuration
Section titled “Configuration”- Alert Rule: The Grafana alert rule to update
- All other fields are optional: only the values you provide will be changed
- Folder / Rule Group: Optional location changes for the rule in Grafana
- Data Source / Query: Optional query details Grafana evaluates
- Lookback / Reducer / Condition / Threshold(s): Optional changes to evaluation and thresholds
- Contact Point: Set to a contact point to attach notifications; clear the value to remove notification settings from the rule
- Labels / Annotations: Optional metadata to update alongside the rule
Output
Section titled “Output”Returns the updated Grafana alert rule object after the provisioning API applies the change.
Example Output
Section titled “Example Output”{ "data": { "annotations": { "summary": "High error rate detected" }, "condition": "C", "data": [ { "datasourceUid": "prometheus-main", "model": { "editorMode": "code", "expr": "sum(rate(http_requests_total{status=~\"5..\"}[5m]))", "intervalMs": 1000, "maxDataPoints": 43200, "query": "sum(rate(http_requests_total{status=~\"5..\"}[5m]))", "refId": "A" }, "queryType": "", "refId": "A", "relativeTimeRange": { "from": 300, "to": 0 } }, { "datasourceUid": "__expr__", "model": { "expression": "A", "id": "reduce", "reducer": "last", "refId": "B", "settings": { "mode": "dropNN" }, "type": "reduce" }, "queryType": "", "refId": "B", "relativeTimeRange": { "from": 0, "to": 0 } }, { "datasourceUid": "__expr__", "model": { "conditions": [ { "evaluator": { "params": [ 1 ], "type": "gt" }, "operator": { "type": "and" }, "query": { "params": [ "C" ] }, "reducer": { "type": "last" }, "type": "query" } ], "expression": "B", "id": "threshold", "refId": "C", "type": "threshold" }, "queryType": "", "refId": "C", "relativeTimeRange": { "from": 0, "to": 0 } } ], "execErrState": "Alerting", "folderUID": "infra", "for": "5m", "id": 42, "isPaused": false, "labels": { "service": "api", "severity": "critical" }, "noDataState": "NoData", "orgID": 1, "ruleGroup": "service-health", "title": "High error rate", "uid": "cergr5pm79hj4d", "updated": "2026-03-31T10:20:30Z" }, "timestamp": "2026-03-31T10:20:30Z", "type": "grafana.alertRule"}