Skip to content

Commit f398591

Browse files
committed
Tighten Send Events API docs: customer-facing wording and param order
- Replace 'accepts any JSON payload' with 'accepts the default payload structure of the supported origins'. - Remove paragraph describing internal storage/parsing behavior. - Replace the 'Unsupported sources' section with a brief 'Other sources' note that does not mention parsers. - Drop incidental references to internal terminology in per-origin pages (per-origin/generic parser, the relay, dedup-key preservation). - Reorder all webhook URL examples to type, origin, account_id.
1 parent c58ccca commit f398591

20 files changed

Lines changed: 46 additions & 53 deletions

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

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,11 @@ This is the recommended ingestion path for new integrations. The legacy :doc:`Se
3232
Overview
3333
--------
3434

35-
The endpoint accepts any JSON payload. The request is parameterized by query string:
35+
The endpoint accepts the default payload structure of the supported origins. The request is parameterized by query string:
3636

3737
.. code-block::
3838
39-
POST https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=<ORIGIN>&type=<TYPE>
40-
41-
Robusta stores every payload verbatim, then asynchronously parses it into the Robusta UI timeline. If a per-origin parser is registered for ``origin``, it is used; otherwise a generic JSON parser handles the payload. Parse failures are visible in the **Delivery Log** UI page so you can self-debug.
39+
POST https://api.robusta.dev/webhooks?type=<TYPE>&origin=<ORIGIN>&account_id=<ACCOUNT_ID>
4240
4341
Query Parameters
4442
----------------
@@ -51,17 +49,17 @@ Query Parameters
5149
- Type
5250
- Description
5351
- Required
54-
* - ``account_id``
52+
* - ``type``
5553
- string
56-
- Your Robusta account ID, found in ``generated_values.yaml``.
54+
- One of ``alert``, ``incident``, or ``change``.
5755
- Yes
5856
* - ``origin``
5957
- string
60-
- Identifies the monitoring product (for example ``alertmanager``, ``pagerduty``, ``datadog``). Free-form; selects the per-origin parser when one exists.
58+
- Identifies the monitoring product (for example ``alertmanager``, ``pagerduty``, ``datadog``).
6159
- Yes
62-
* - ``type``
60+
* - ``account_id``
6361
- string
64-
- One of ``alert``, ``incident``, or ``change``.
62+
- Your Robusta account ID, found in ``generated_values.yaml``.
6563
- Yes
6664

6765
Authentication
@@ -81,7 +79,7 @@ Example Request
8179
.. code-block:: bash
8280
8381
curl --location --request POST \
84-
'https://api.robusta.dev/webhooks?account_id=ACCOUNT_ID&origin=datadog&type=alert' \
82+
'https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=ACCOUNT_ID' \
8583
--header 'Authorization: Bearer API_KEY' \
8684
--header 'Content-Type: application/json' \
8785
--data-raw '{ "title": "High error rate", "severity": "high" }'
@@ -238,12 +236,7 @@ Other
238236
:link: send-events/solarwinds
239237
:link-type: doc
240238

241-
Unsupported sources
242-
-------------------
243-
244-
Any monitoring system that can POST JSON to a URL works. Pick a free-form ``origin`` value, paste the URL into the vendor's webhook configuration, and Robusta's generic parser will handle the payload. The AI investigator reads the raw payload along with the structured event, so source-specific fields are preserved even without a dedicated parser.
245-
246-
Delivery Log
247-
------------
239+
Other sources
240+
-------------
248241

249-
Every received payload — parsed, pending, or failed — is visible in the Robusta UI under **Settings → Delivery Log**, scoped to your account and sorted by recency. Use it to confirm that a vendor is reaching Robusta, view the original request body, and inspect parser errors.
242+
Any monitoring system that can POST JSON to a URL is supported. Choose a value for ``origin`` that identifies your source, then paste the URL into your vendor's webhook configuration.

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

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

4-
Forward Prometheus alerts from AlertManager directly to Robusta. Robusta's per-origin parser maps AlertManager labels and annotations onto the timeline; the original payload is preserved for HolmesGPT.
4+
Forward Prometheus alerts from AlertManager directly to Robusta.
55

66
Prerequisites
77
-------------
@@ -15,7 +15,7 @@ Webhook URL
1515

1616
.. code-block::
1717
18-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=alertmanager&type=alert
18+
https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>
1919
2020
Configure AlertManager
2121
----------------------
@@ -27,7 +27,7 @@ Add a webhook receiver to ``alertmanager.yml``:
2727
receivers:
2828
- name: robusta
2929
webhook_configs:
30-
- url: 'https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=alertmanager&type=alert'
30+
- url: 'https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>'
3131
send_resolved: true
3232
http_config:
3333
authorization:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Webhook URL
1616

1717
.. code-block::
1818
19-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=argocd&type=change
19+
https://api.robusta.dev/webhooks?type=change&origin=argocd&account_id=<ACCOUNT_ID>
2020
2121
Configure Argo CD Notifications
2222
--------------------------------
@@ -26,7 +26,7 @@ Add a webhook service and a template to ``argocd-notifications-cm``:
2626
.. code-block:: yaml
2727
2828
service.webhook.robusta: |
29-
url: https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=argocd&type=change
29+
url: https://api.robusta.dev/webhooks?type=change&origin=argocd&account_id=<ACCOUNT_ID>
3030
headers:
3131
- name: Authorization
3232
value: Bearer <ROBUSTA_API_KEY>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Webhook URL
1616

1717
.. code-block::
1818
19-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=awscloudwatch&type=alert
19+
https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>
2020
2121
Recipe
2222
------
@@ -32,7 +32,7 @@ Recipe
3232
import urllib.error
3333
import urllib.request
3434
35-
URL = "https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=awscloudwatch&type=alert"
35+
URL = "https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>"
3636
TIMEOUT_SECONDS = 5
3737
3838
def lambda_handler(event, context):

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Webhook URL
1616

1717
.. code-block::
1818
19-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=azure&type=alert
19+
https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>
2020
2121
Configure Azure
2222
---------------
@@ -25,11 +25,11 @@ Action Group webhook receivers do not allow custom headers, so authenticate via
2525

2626
.. code-block::
2727
28-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=azure&type=alert&token=<ROBUSTA_API_KEY>
28+
https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
2929
3030
1. In the Azure Portal, open **Monitor → Action groups** and either create a new group or edit an existing one.
3131
2. Under **Actions**, add an action of type **Webhook**.
32-
3. Name it ``Robusta`` and set the **URI** to the URL above. Leave **Enable the common alert schema** on — Robusta's parser is built against it.
32+
3. Name it ``Robusta`` and set the **URI** to the URL above. Leave **Enable the common alert schema** on.
3333
4. Save the action group and attach it to the alert rules you want to forward.
3434

3535
Verify

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Webhook URL
1616

1717
.. code-block::
1818
19-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=datadog&type=alert
19+
https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=<ACCOUNT_ID>
2020
2121
Configure Datadog
2222
-----------------
@@ -29,7 +29,7 @@ Configure Datadog
2929
3030
{ "Authorization": "Bearer <ROBUSTA_API_KEY>" }
3131
32-
4. Leave the default payload, or customize it. Robusta's per-origin parser handles the standard Datadog payload shape.
32+
4. Leave the default payload.
3333
5. Save. In any monitor, set the **Notify** field to ``@webhook-robusta`` to forward its alerts to Robusta.
3434

3535
Verify

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Webhook URL
1616

1717
.. code-block::
1818
19-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=dynatrace&type=alert
19+
https://api.robusta.dev/webhooks?type=alert&origin=dynatrace&account_id=<ACCOUNT_ID>
2020
2121
Configure Dynatrace
2222
-------------------
@@ -29,7 +29,7 @@ Configure Dynatrace
2929
3030
Authorization: Bearer <ROBUSTA_API_KEY>
3131
32-
4. Use the default JSON payload template, or customize it. Robusta's generic parser handles arbitrary fields.
32+
4. Use the default JSON payload template.
3333
5. Save and assign the integration to your alerting profile.
3434

3535
Verify

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Webhook URL
1616

1717
.. code-block::
1818
19-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=gcp&type=alert
19+
https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>
2020
2121
Configure GCP
2222
-------------
@@ -25,9 +25,9 @@ GCP webhook notification channels do not support custom headers in the console,
2525

2626
.. code-block::
2727
28-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=gcp&type=alert&token=<ROBUSTA_API_KEY>
28+
https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
2929
30-
The relay accepts ``token`` as an alternate to the ``Authorization`` header.
30+
The ``token`` query parameter is accepted as an alternative to the ``Authorization`` header.
3131

3232
1. In the GCP Console, go to **Monitoring → Alerting → Edit Notification Channels**.
3333
2. Click **Add new** under **Webhooks**.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Webhook URL
1616

1717
.. code-block::
1818
19-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=github&type=change
19+
https://api.robusta.dev/webhooks?type=change&origin=github&account_id=<ACCOUNT_ID>
2020
2121
Configure GitHub
2222
----------------
@@ -28,7 +28,7 @@ Configure GitHub
2828

2929
.. code-block::
3030
31-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=github&type=change&token=<ROBUSTA_API_KEY>
31+
https://api.robusta.dev/webhooks?type=change&origin=github&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
3232
3333
.. warning::
3434

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Webhook URL
1616

1717
.. code-block::
1818
19-
https://api.robusta.dev/webhooks?account_id=<ACCOUNT_ID>&origin=grafana&type=alert
19+
https://api.robusta.dev/webhooks?type=alert&origin=grafana&account_id=<ACCOUNT_ID>
2020
2121
Configure Grafana
2222
-----------------

0 commit comments

Comments
 (0)