You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: docs/configuration/exporting/send-events-api.rst
+11-18Lines changed: 11 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,13 +32,11 @@ This is the recommended ingestion path for new integrations. The legacy :doc:`Se
32
32
Overview
33
33
--------
34
34
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:
36
36
37
37
.. code-block::
38
38
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>
42
40
43
41
Query Parameters
44
42
----------------
@@ -51,17 +49,17 @@ Query Parameters
51
49
- Type
52
50
- Description
53
51
- Required
54
-
* - ``account_id``
52
+
* - ``type``
55
53
- string
56
-
- Your Robusta account ID, found in ``generated_values.yaml``.
54
+
- One of ``alert``, ``incident``, or ``change``.
57
55
- Yes
58
56
* - ``origin``
59
57
- 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``).
61
59
- Yes
62
-
* - ``type``
60
+
* - ``account_id``
63
61
- string
64
-
- One of ``alert``, ``incident``, or ``change``.
62
+
- Your Robusta account ID, found in ``generated_values.yaml``.
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
+
-------------
248
241
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.
Copy file name to clipboardExpand all lines: docs/configuration/exporting/send-events/alertmanager.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
AlertManager
2
2
=============
3
3
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.
0 commit comments