Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/configuration/exporting/send-events-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Endpoint

.. robusta-code::

POST https://api.robusta.dev/webhooks?type=alert&origin=<ORIGIN>&account_id=<ACCOUNT_ID>
POST https://api.robusta.dev/webhooks?type=alert&origin=<ORIGIN>&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Query Parameters
----------------
Expand All @@ -50,7 +50,7 @@ Query Parameters
* - ``account_id``
- Your Robusta account ID, found in ``generated_values.yaml``.
* - ``cluster``
- Optional. The cluster to associate the alert with. When set, it overrides any cluster found in the alert payload and is used for the resulting alert investigation. When omitted, the cluster is taken from the payload if present, otherwise the alert is recorded under the ``external`` cluster. Use this when your monitoring system cannot add a cluster label to the alert itself.
- Recommended. The cluster to file the alert under — use the exact name shown in the Robusta UI. Overrides any cluster in the alert payload. If omitted, the cluster is taken from the payload, or silently defaults to ``external``.

Authentication
--------------
Expand All @@ -69,7 +69,7 @@ Example Request
.. robusta-code:: bash

curl --location --request POST \
'https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=ACCOUNT_ID' \
'https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=ACCOUNT_ID&cluster=CLUSTER_NAME' \
--header 'Authorization: Bearer API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{ "title": "High error rate", "severity": "high" }'
Expand Down
10 changes: 8 additions & 2 deletions docs/configuration/exporting/send-events/alertmanager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

.. note::

Alerts can also carry the cluster as a ``cluster`` or ``cluster_name`` label (e.g. via Prometheus ``externalLabels``); the URL parameter takes precedence. The :doc:`in-cluster integration </configuration/alertmanager-integration/outofcluster-prometheus>` is a separate mechanism that routes by label only.

Configure AlertManager
----------------------
Expand All @@ -27,7 +33,7 @@ Add a webhook receiver to ``alertmanager.yml``:
receivers:
- name: robusta
webhook_configs:
- url: 'https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>'
- url: 'https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>'
send_resolved: true
http_config:
authorization:
Expand Down
8 changes: 5 additions & 3 deletions docs/configuration/exporting/send-events/aws-cloudwatch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Recipe
------
Expand All @@ -32,7 +34,7 @@ Recipe
import urllib.error
import urllib.request

URL = "https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>"
URL = "https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>"
TIMEOUT_SECONDS = 5

def lambda_handler(event, context):
Expand All @@ -54,7 +56,7 @@ Recipe
raise
return {"ok": True}

4. Replace ``<ACCOUNT_ID>`` with your Robusta account ID and deploy.
4. Replace ``<ACCOUNT_ID>`` with your Robusta account ID and ``<CLUSTER_NAME>`` with your cluster's name as it appears in the Robusta UI, then deploy.

Alternatively, if you already use **Amazon EventBridge → API destination**, point the destination at the same URL with a Bearer token connection — no Lambda required.

Expand Down
6 changes: 4 additions & 2 deletions docs/configuration/exporting/send-events/azure-monitor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure Azure
---------------
Expand All @@ -25,7 +27,7 @@ Action Group webhook receivers do not allow custom headers, so authenticate via

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>&token=<ROBUSTA_API_KEY>

1. In the Azure Portal, open **Monitor → Action groups** and either create a new group or edit an existing one.
2. Under **Actions**, add an action of type **Webhook**.
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration/exporting/send-events/datadog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure Datadog
-----------------
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration/exporting/send-events/dynatrace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=dynatrace&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=dynatrace&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure Dynatrace
-------------------
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration/exporting/send-events/f5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=f5&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=f5&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
Comment thread
coderabbitai[bot] marked this conversation as resolved.

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure F5 Distributed Cloud
------------------------------
Expand Down
6 changes: 4 additions & 2 deletions docs/configuration/exporting/send-events/gcp-monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure GCP
-------------
Expand All @@ -25,7 +27,7 @@ GCP webhook notification channels do not support custom headers in the console,

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>&token=<ROBUSTA_API_KEY>

The ``token`` query parameter is accepted as an alternative to the ``Authorization`` header.

Expand Down
4 changes: 3 additions & 1 deletion docs/configuration/exporting/send-events/grafana.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=grafana&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=grafana&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure Grafana
-----------------
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration/exporting/send-events/jsm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=jsm&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=jsm&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure Jira Service Management
---------------------------------
Expand Down
6 changes: 4 additions & 2 deletions docs/configuration/exporting/send-events/nagios.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=nagios&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=nagios&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure Nagios
----------------
Expand Down Expand Up @@ -51,7 +53,7 @@ Define a notification command that references ``$USER20$``:
"type": "$NOTIFICATIONTYPE$",
"output": "$SERVICEOUTPUT$"
}' \
'https://api.robusta.dev/webhooks?type=alert&origin=nagios&account_id=<ACCOUNT_ID>'
'https://api.robusta.dev/webhooks?type=alert&origin=nagios&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>'
}

Define an analogous ``notify-robusta-host`` command, then attach both to a Nagios contact:
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration/exporting/send-events/newrelic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=newrelic&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=newrelic&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure New Relic
-------------------
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration/exporting/send-events/opsgenie.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=opsgenie&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=opsgenie&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure Opsgenie
------------------
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration/exporting/send-events/pagerduty.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=pagerduty&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=pagerduty&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure PagerDuty
-------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/exporting/send-events/rootly.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=rootly&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
https://api.robusta.dev/webhooks?type=alert&origin=rootly&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>&token=<ROBUSTA_API_KEY>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<ROBUSTA_API_KEY>`` with the API key you generated.
Replace ``<ACCOUNT_ID>`` with your Robusta account id, ``<ROBUSTA_API_KEY>`` with the API key you generated, and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure Rootly
----------------
Expand Down
9 changes: 6 additions & 3 deletions docs/configuration/exporting/send-events/sentry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,13 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=sentry&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
https://api.robusta.dev/webhooks?type=alert&origin=sentry&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>&token=<ROBUSTA_API_KEY>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and
``<ROBUSTA_API_KEY>`` with the API key you just generated.
Replace ``<ACCOUNT_ID>`` with your Robusta account id,
``<ROBUSTA_API_KEY>`` with the API key you just generated, and
``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in
the Robusta UI. If ``cluster`` is omitted, alerts are filed under a
generic ``external`` cluster.

.. note::

Expand Down
6 changes: 4 additions & 2 deletions docs/configuration/exporting/send-events/solarwinds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=solarwinds&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=solarwinds&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure SolarWinds
--------------------
Expand All @@ -25,7 +27,7 @@ SolarWinds does not ship a native bearer-token webhook action. Use the **Execute

.. robusta-code::

curl -sS -X POST -H "Authorization: Bearer <ROBUSTA_API_KEY>" -H "Content-Type: application/json" --data "{ \"alertName\": \"${N=Alerting;M=AlertName}\", \"node\": \"${N=SwisEntity;M=Caption}\", \"severity\": \"${N=Alerting;M=Severity}\", \"message\": \"${N=Alerting;M=AlertMessage}\" }" "https://api.robusta.dev/webhooks?type=alert&origin=solarwinds&account_id=<ACCOUNT_ID>"
curl -sS -X POST -H "Authorization: Bearer <ROBUSTA_API_KEY>" -H "Content-Type: application/json" --data "{ \"alertName\": \"${N=Alerting;M=AlertName}\", \"node\": \"${N=SwisEntity;M=Caption}\", \"severity\": \"${N=Alerting;M=Severity}\", \"message\": \"${N=Alerting;M=AlertMessage}\" }" "https://api.robusta.dev/webhooks?type=alert&origin=solarwinds&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>"

Save the action and attach it to the alerts you want forwarded.

Expand Down
6 changes: 4 additions & 2 deletions docs/configuration/exporting/send-events/splunk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Webhook URL

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=splunk&account_id=<ACCOUNT_ID>
https://api.robusta.dev/webhooks?type=alert&origin=splunk&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>

Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster.

Configure Splunk
----------------
Expand All @@ -28,7 +30,7 @@ Splunk's built-in **Webhook** alert action does not let you set custom headers,

.. robusta-code::

https://api.robusta.dev/webhooks?type=alert&origin=splunk&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
https://api.robusta.dev/webhooks?type=alert&origin=splunk&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>&token=<ROBUSTA_API_KEY>

3. Save the search. If your Splunk environment has the **Webhook Alert Action** app installed, you can instead set an ``Authorization: Bearer <ROBUSTA_API_KEY>`` header and use the plain webhook URL without ``&token=…``.

Expand Down
Loading