From 54ad3aff3e99253675c4e55da6bd6196ff053eb4 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 26 Aug 2026 22:11:50 +0000 Subject: [PATCH 1/2] Document the trigger_workflow action in the Actions Reference Add a Robusta Platform Triggered Workflows section to the miscellaneous actions page, documenting the trigger_workflow action added in #2133: where to get the workflow id and API key, the region-aware webhooks URL, and a full customPlaybooks example. Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01BzuXuiFCUyAEHtiSNiRXGw --- .../actions/miscellaneous.rst | 33 ++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/playbook-reference/actions/miscellaneous.rst b/docs/playbook-reference/actions/miscellaneous.rst index 1522b4951..ff6d67ba4 100644 --- a/docs/playbook-reference/actions/miscellaneous.rst +++ b/docs/playbook-reference/actions/miscellaneous.rst @@ -37,4 +37,35 @@ Stress Testing and Chaos Engineering Adding Slack user/group mentions to k8s/Prometheus events --------------------------------------------------------- -.. robusta-action:: playbooks.robusta_playbooks.alerts_integration.mention_enricher \ No newline at end of file +.. robusta-action:: playbooks.robusta_playbooks.alerts_integration.mention_enricher + +Robusta Platform Triggered Workflows +--------------------------------------------------------- + +Run Triggered Workflows defined in the Robusta SaaS platform — typically Holmes investigations — in response to Prometheus alerts in your cluster. + +.. robusta-action:: playbooks.robusta_playbooks.workflow_trigger.trigger_workflow on_prometheus_alert + + **Where to get the values:** + + * ``workflow_id`` — the id of the Triggered Workflow, copied from the workflow's page in the Robusta UI. Pass a list of ids to run several workflows from the same alert. + * ``api_key`` — in the Robusta UI, go to **Settings → API Keys**, click **New API Key**, and grant it **Write** access to alerts. Don't commit the key to your values file — reference an environment variable instead, e.g. ``api_key: "{{ env.ROBUSTA_PLATFORM_API_KEY }}"``. + + If your Robusta account is hosted in the EU or AP region, set ``url`` to the matching regional endpoint: + + .. robusta-code:: yaml + + url: "https://api.robusta.dev/webhooks" + + For example, to run a Holmes investigation whenever a specific alert fires: + + .. code-block:: yaml + + customPlaybooks: + - triggers: + - on_prometheus_alert: + alert_name: NodeCordonedManually + actions: + - trigger_workflow: + workflow_id: "b7f9d2e4-1234-4c56-9abc-0123456789ab" + api_key: "{{ env.ROBUSTA_PLATFORM_API_KEY }}" \ No newline at end of file From 44cc052b0a4b56ac8f39a74992c734d0ee6e770d Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 26 Aug 2026 22:51:02 +0000 Subject: [PATCH 2/2] Simplify trigger_workflow docs to the bare robusta-action directive Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01BzuXuiFCUyAEHtiSNiRXGw --- .../actions/miscellaneous.rst | 28 +------------------ 1 file changed, 1 insertion(+), 27 deletions(-) diff --git a/docs/playbook-reference/actions/miscellaneous.rst b/docs/playbook-reference/actions/miscellaneous.rst index ff6d67ba4..55aaaacfd 100644 --- a/docs/playbook-reference/actions/miscellaneous.rst +++ b/docs/playbook-reference/actions/miscellaneous.rst @@ -42,30 +42,4 @@ Adding Slack user/group mentions to k8s/Prometheus events Robusta Platform Triggered Workflows --------------------------------------------------------- -Run Triggered Workflows defined in the Robusta SaaS platform — typically Holmes investigations — in response to Prometheus alerts in your cluster. - -.. robusta-action:: playbooks.robusta_playbooks.workflow_trigger.trigger_workflow on_prometheus_alert - - **Where to get the values:** - - * ``workflow_id`` — the id of the Triggered Workflow, copied from the workflow's page in the Robusta UI. Pass a list of ids to run several workflows from the same alert. - * ``api_key`` — in the Robusta UI, go to **Settings → API Keys**, click **New API Key**, and grant it **Write** access to alerts. Don't commit the key to your values file — reference an environment variable instead, e.g. ``api_key: "{{ env.ROBUSTA_PLATFORM_API_KEY }}"``. - - If your Robusta account is hosted in the EU or AP region, set ``url`` to the matching regional endpoint: - - .. robusta-code:: yaml - - url: "https://api.robusta.dev/webhooks" - - For example, to run a Holmes investigation whenever a specific alert fires: - - .. code-block:: yaml - - customPlaybooks: - - triggers: - - on_prometheus_alert: - alert_name: NodeCordonedManually - actions: - - trigger_workflow: - workflow_id: "b7f9d2e4-1234-4c56-9abc-0123456789ab" - api_key: "{{ env.ROBUSTA_PLATFORM_API_KEY }}" \ No newline at end of file +.. robusta-action:: playbooks.robusta_playbooks.workflow_trigger.trigger_workflow on_prometheus_alert \ No newline at end of file