Skip to content

Commit 1cedc9a

Browse files
committed
Restrict Send Events API docs to alerts only
Only the alert type is supported today. Remove origins that only produce incidents (Rootly, Incident.io) or changes (Argo CD, GitHub, LaunchDarkly), drop the Incident Management → Rootly/ Incident.io and Changes & Deployments cards, simplify the type parameter to require 'alert', and rewrite PagerDuty for the AIOps alert flow only.
1 parent 42bc0b7 commit 1cedc9a

7 files changed

Lines changed: 11 additions & 276 deletions

File tree

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

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

4-
Send alerts, incidents, and changes from any monitoring system to Robusta through a single webhook endpoint. HolmesGPT investigates each event against your live cluster state, logs, metrics, and connected data sources, and attaches its findings to help accelerate triage.
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.
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

@@ -19,12 +19,7 @@ This is the recommended ingestion path for new integrations. The legacy :doc:`Se
1919
send-events/azure-monitor
2020
send-events/splunk
2121
send-events/sentry
22-
send-events/launchdarkly
23-
send-events/argocd
24-
send-events/github
2522
send-events/opsgenie
26-
send-events/rootly
27-
send-events/incidentio
2823
send-events/nagios
2924
send-events/solarwinds
3025
send-events/aws-cloudwatch
@@ -36,7 +31,7 @@ The endpoint accepts the default payload structure of the supported origins. The
3631

3732
.. code-block::
3833
39-
POST https://api.robusta.dev/webhooks?type=<TYPE>&origin=<ORIGIN>&account_id=<ACCOUNT_ID>
34+
POST https://api.robusta.dev/webhooks?type=alert&origin=<ORIGIN>&account_id=<ACCOUNT_ID>
4035
4136
Query Parameters
4237
----------------
@@ -51,7 +46,7 @@ Query Parameters
5146
- Required
5247
* - ``type``
5348
- string
54-
- One of ``alert``, ``incident``, or ``change``.
49+
- Must be ``alert``.
5550
- Yes
5651
* - ``origin``
5752
- string
@@ -189,37 +184,6 @@ Incident Management
189184
:link: send-events/opsgenie
190185
:link-type: doc
191186

192-
.. grid-item-card:: :octicon:`pulse;1em;` Rootly
193-
:class-card: sd-bg-light sd-bg-text-light
194-
:link: send-events/rootly
195-
:link-type: doc
196-
197-
.. grid-item-card:: :octicon:`pulse;1em;` Incident.io
198-
:class-card: sd-bg-light sd-bg-text-light
199-
:link: send-events/incidentio
200-
:link-type: doc
201-
202-
Changes & Deployments
203-
~~~~~~~~~~~~~~~~~~~~~~
204-
205-
.. grid:: 1 1 2 3
206-
:gutter: 3
207-
208-
.. grid-item-card:: :octicon:`package;1em;` Argo CD
209-
:class-card: sd-bg-light sd-bg-text-light
210-
:link: send-events/argocd
211-
:link-type: doc
212-
213-
.. grid-item-card:: :octicon:`mark-github;1em;` GitHub
214-
:class-card: sd-bg-light sd-bg-text-light
215-
:link: send-events/github
216-
:link-type: doc
217-
218-
.. grid-item-card:: :octicon:`plug;1em;` LaunchDarkly
219-
:class-card: sd-bg-light sd-bg-text-light
220-
:link: send-events/launchdarkly
221-
:link-type: doc
222-
223187
Other
224188
~~~~~~
225189

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

Lines changed: 0 additions & 68 deletions
This file was deleted.

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

Lines changed: 0 additions & 42 deletions
This file was deleted.

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

Lines changed: 0 additions & 37 deletions
This file was deleted.

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

Lines changed: 0 additions & 36 deletions
This file was deleted.
Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,38 @@
11
PagerDuty
22
==========
33

4-
Forward PagerDuty incidents (and AIOps alerts) to Robusta via Generic Webhooks v3.
4+
Forward PagerDuty alerts to Robusta via PagerDuty AIOps Event Orchestration.
55

66
Prerequisites
77
-------------
88

99
* A Robusta account with API access.
1010
* Your Robusta ``account_id``, found in ``generated_values.yaml``.
1111
* A Robusta API key with ``Read/Write`` access to alerts, generated under **Settings → API Keys → New API Key**.
12-
* A PagerDuty admin able to create webhooks. AIOps Event Orchestration is required to forward full alert-level data.
12+
* An AIOps-enabled PagerDuty plan with admin access to Event Orchestration.
1313

1414
Webhook URL
1515
-----------
1616

17-
For incidents:
18-
19-
.. code-block::
20-
21-
https://api.robusta.dev/webhooks?type=incident&origin=pagerduty&account_id=<ACCOUNT_ID>
22-
23-
For AIOps-forwarded alerts:
24-
2517
.. code-block::
2618
2719
https://api.robusta.dev/webhooks?type=alert&origin=pagerduty&account_id=<ACCOUNT_ID>
2820
2921
Configure PagerDuty
3022
-------------------
3123

32-
1. In PagerDuty, go to **Integrations → Generic Webhooks v3** and click **New Webhook**.
33-
2. Set the **Webhook URL** to the URL above.
34-
3. Add a custom header:
24+
1. In PagerDuty, go to **AIOps → Event Orchestration** and open the orchestration that handles the alerts you want forwarded.
25+
2. Under **Automation → Webhook Actions**, add a new webhook.
26+
3. Set the **Webhook URL** to the URL above.
27+
4. Add a custom header:
3528

3629
.. code-block::
3730
3831
Authorization: Bearer <ROBUSTA_API_KEY>
3932
40-
4. Save. PagerDuty will sign the payload, but Robusta authenticates on the API key alone — the signature is ignored.
41-
42-
For AIOps event-level forwarding, repeat the same steps inside **AIOps → Event Orchestration → Webhook Action** and target the ``type=alert`` URL.
33+
5. Save. PagerDuty will sign the payload, but Robusta authenticates on the API key alone — the signature is ignored.
4334

4435
Verify
4536
------
4637

47-
Trigger a test incident in PagerDuty. It should appear in **Settings → Delivery Log** and on the Robusta timeline.
38+
Trigger a test alert in PagerDuty. It should appear in **Settings → Delivery Log** and on the Robusta timeline.

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

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)