Configuring a Webhook

Webhooks allow RealTheory to send real-time notifications about Kubernetes events to an external service you specify. When a configured event occurs — such as a critical alert being raised against a Kubernetes object — RealTheory sends an HTTP POST request with event details to the payload URL you provide.

Prerequisites

To manage webhooks, you must have one of the following roles assigned to your user account:

• sys_admin
• webhook_admin

Procedure

1. Navigate to Settings > Webhooks.

2. Click Add Webhook.

3. If you want this webhook to be active immediately upon saving, leave Make webhook active selected.

4. Provide a unique Name for this webhook.

5. Optionally, enter a Description to help identify the purpose of this webhook.

6. In Payload URL, enter the URL of the endpoint that will receive the webhook POST requests.

7. The Content Type is set to Application JSON by default; this is currently the only supported content type.

8. In the Authentication dropdown, select the authentication method required by your endpoint:

   • None — No authentication. Select this if your endpoint does not require credentials.
   • Basic Auth — Sends a username and password with each request sent to your endpoint.

9. Optionally, enter a Secret to include a digital signature with each request.
   Your endpoint can use this signature to validate that requests originate from RealTheory.

10. By default, this webhook will fire for all events, all rules, and all Kubernetes objects. Update any of the following criteria to narrow the scope.
    Events

    • All events — the webhook fires for every supported event type.

    • Let me select which events — choose one or more of the following:

      • Critical alert raised — a critical alert has been raised against a Kubernetes object.
      • High alert raised — a high alert has been raised against a Kubernetes object.
      • Normal alert raised — a normal alert has been raised against a Kubernetes object.

    Rules

    • All rules — the webhook fires for events generated by any rule.

    • Let me select which rules — choose one or more rule categories: Reliability, Cost, Performance, Governance.

      Note: To further narrow the rules that trigger this webhook, you can enter one or more rule names in Rule names. Separate multiple names with commas. Wildcards are supported — for example, *Utilization or CPU Usage.

    Kubernetes objects

    • All Kubernetes objects — the webhook fires for events on any object type.

    • Let me select which Kubernetes object — choose one or more object types: Cluster, Namespace, Service, DaemonSet, StatefulSet, Node, Pod, Deployment, ReplicaSet.

      Note: To further narrow which objects trigger this webhook, enter specific object names in Object list and/or Object labels.

11. Verify the configuration, and then click Add Webhook.
    The new webhook will appear in the Configured Webhooks table. If Make webhook active was selected, the webhook will begin delivering notifications immediately.

See Also
Viewing Webhook Delivery Status
How To: Process a System Alert WebHook