Skip to content

Commit df2f77f

Browse files
committed
Trim Send Events API docs to setup-only content
- Drop HMAC/signature-ignored note on PagerDuty page. - Replace Delivery Log mentions in every Verify section with a simple 'alert should appear on the Robusta timeline' line. - Trim the main page: remove HolmesGPT marketing sentence, the Response/Errors sections, rate-limit numbers, and the 401-on-mismatch note. - Collapse the Query Parameters table from four columns to two. - Shorten the Nagios resource.cfg security explanation. - Drop the 'token is an alternative to Authorization' meta note from the GCP page.
1 parent aafd0b0 commit df2f77f

15 files changed

Lines changed: 21 additions & 54 deletions

docs/configuration/exporting/send-events-api.rst

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Send Events API
22
================
33

4-
Send alerts from any monitoring system to Robusta through a single webhook endpoint. HolmesGPT investigates each alert against your live cluster state, logs, metrics, and connected data sources, and attaches its findings to help accelerate triage.
4+
Send alerts from your monitoring system to Robusta through a single webhook endpoint.
55

66
This is the recommended ingestion path for new integrations. The legacy :doc:`Send Alerts API </configuration/exporting/send-alerts-api>` remains available for existing customers.
77

@@ -24,11 +24,9 @@ This is the recommended ingestion path for new integrations. The legacy :doc:`Se
2424
send-events/solarwinds
2525
send-events/splunk
2626

27-
Overview
27+
Endpoint
2828
--------
2929

30-
The endpoint accepts the default payload structure of the supported origins. The request is parameterized by query string:
31-
3230
.. code-block::
3331
3432
POST https://api.robusta.dev/webhooks?type=alert&origin=<ORIGIN>&account_id=<ACCOUNT_ID>
@@ -37,25 +35,17 @@ Query Parameters
3735
----------------
3836

3937
.. list-table::
40-
:widths: 20 10 60 10
38+
:widths: 20 70
4139
:header-rows: 1
4240

4341
* - Parameter
44-
- Type
4542
- Description
46-
- Required
4743
* - ``type``
48-
- string
4944
- Must be ``alert``.
50-
- Yes
5145
* - ``origin``
52-
- string
5346
- Identifies the monitoring product. Must be one of the supported origins listed under `Integrations`_ below.
54-
- Yes
5547
* - ``account_id``
56-
- string
5748
- Your Robusta account ID, found in ``generated_values.yaml``.
58-
- Yes
5949

6050
Authentication
6151
--------------
@@ -66,8 +56,6 @@ Send your Robusta API key as a Bearer token. Generate keys in the Robusta UI und
6656
6757
Authorization: Bearer <API_KEY>
6858
69-
The key must be scoped to the ``account_id`` query parameter. Mismatches return ``401``.
70-
7159
Example Request
7260
---------------
7361

@@ -79,22 +67,6 @@ Example Request
7967
--header 'Content-Type: application/json' \
8068
--data-raw '{ "title": "High error rate", "severity": "high" }'
8169
82-
Response
83-
--------
84-
85-
A successful request returns ``200`` with the ID of the stored event:
86-
87-
.. code-block:: json
88-
89-
{ "id": "8f1b...e21" }
90-
91-
Errors:
92-
93-
* ``400`` — missing or empty ``account_id``, ``origin``, or ``type``; invalid ``type`` value.
94-
* ``401`` — invalid or out-of-scope API key.
95-
* ``429`` — rate limit exceeded (300 requests per 5-minute window per account).
96-
* ``503`` — transient storage failure; vendors should retry.
97-
9870
Integrations
9971
------------
10072

@@ -199,4 +171,3 @@ Other
199171
:class-card: sd-bg-light sd-bg-text-light
200172
:link: send-events/solarwinds
201173
:link-type: doc
202-

docs/configuration/exporting/send-events/alertmanager.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ Set ``continue: true`` if Robusta is not your only receiver, so alerts also reac
4343
Verify
4444
------
4545

46-
Open **Settings → Delivery Log** in the Robusta UI to see the request arrive, then check the timeline for the parsed alert.
46+
The alert should appear on the Robusta timeline.

docs/configuration/exporting/send-events/aws-cloudwatch.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ Alternatively, if you already use **Amazon EventBridge → API destination**, po
6161
Verify
6262
------
6363

64-
Use the **Test alarm** action in CloudWatch. The event should appear in **Settings → Delivery Log** and on the Robusta timeline.
64+
Use the **Test alarm** action in CloudWatch. The alert should appear on the Robusta timeline.

docs/configuration/exporting/send-events/azure-monitor.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ Action Group webhook receivers do not allow custom headers, so authenticate via
3535
Verify
3636
------
3737

38-
Use the action group's **Test** option. The event should appear in **Settings → Delivery Log** and on the Robusta timeline.
38+
Use the action group's **Test** option. The alert should appear on the Robusta timeline.

docs/configuration/exporting/send-events/datadog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ Configure Datadog
3535
Verify
3636
------
3737

38-
Trigger a test alert from a Datadog monitor. The event should appear in **Settings → Delivery Log** and on the Robusta timeline.
38+
Trigger a test alert from a Datadog monitor. The alert should appear on the Robusta timeline.

docs/configuration/exporting/send-events/dynatrace.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ Configure Dynatrace
3535
Verify
3636
------
3737

38-
Use the **Send test notification** button. The event should appear in **Settings → Delivery Log** and on the Robusta timeline.
38+
Use the **Send test notification** button. The alert should appear on the Robusta timeline.

docs/configuration/exporting/send-events/gcp-monitoring.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ GCP webhook notification channels do not support custom headers in the console,
2727
2828
https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
2929
30-
The ``token`` query parameter is accepted as an alternative to the ``Authorization`` header.
31-
3230
1. In the GCP Console, go to **Monitoring → Alerting → Edit Notification Channels**.
3331
2. Click **Add new** under **Webhooks**.
3432
3. Set the **Endpoint URL** to the URL above and name it ``Robusta``.
@@ -37,4 +35,4 @@ The ``token`` query parameter is accepted as an alternative to the ``Authorizati
3735
Verify
3836
------
3937

40-
Use **Send test notification** on the channel. The event should appear in **Settings → Delivery Log** and on the Robusta timeline.
38+
Use **Send test notification** on the channel. The alert should appear on the Robusta timeline.

docs/configuration/exporting/send-events/grafana.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ Configure Grafana
3535
Verify
3636
------
3737

38-
Use Grafana's **Test** button on the contact point. The event should appear in **Settings → Delivery Log** and on the Robusta timeline.
38+
Use Grafana's **Test** button on the contact point. The alert should appear on the Robusta timeline.

docs/configuration/exporting/send-events/nagios.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,21 @@ Webhook URL
2121
Configure Nagios
2222
----------------
2323

24-
Nagios delivers notifications by running shell commands. Define a command that POSTs the alert as JSON.
25-
26-
Store the API key in ``resource.cfg`` rather than inlining it in ``commands.cfg`` so that it does not appear in command definitions, command-line process listings, or backups of the main configuration:
24+
Store the API key in ``resource.cfg`` so it does not appear in command definitions or process listings:
2725

2826
.. code-block::
2927
3028
# /etc/nagios/resource.cfg
3129
$USER20$=<ROBUSTA_API_KEY>
3230
33-
Nagios resource macros are intentionally not exposed to the CGIs and can hold secrets. Tighten the file permissions so only the Nagios user can read it, and exclude ``resource.cfg`` from any unprotected backup or config-management bundle:
31+
Restrict the file to the Nagios user:
3432

3533
.. code-block:: bash
3634
3735
chown root:nagios /etc/nagios/resource.cfg
3836
chmod 640 /etc/nagios/resource.cfg
3937
40-
Then reference ``$USER20$`` from the notification command:
38+
Define a notification command that references ``$USER20$``:
4139

4240
.. code-block::
4341
@@ -73,4 +71,4 @@ Add ``robusta`` to the ``contact_groups`` you want to forward.
7371
Verify
7472
------
7573

76-
Acknowledge a test problem to fire a notification. The event should appear in **Settings → Delivery Log** and on the Robusta timeline.
74+
Acknowledge a test problem to fire a notification. The alert should appear on the Robusta timeline.

docs/configuration/exporting/send-events/newrelic.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ Configure New Relic
3535
Verify
3636
------
3737

38-
Trigger a test incident in New Relic. The event should appear in **Settings → Delivery Log** and on the Robusta timeline.
38+
Trigger a test incident in New Relic. The alert should appear on the Robusta timeline.

0 commit comments

Comments
 (0)