Skip to main content

Webhook alert method

Reading time: 0 minute(s) (0 words)

The webhook alert method sends alerts through an HTTP callback handler that is triggered by an event. You can create webhooks and configure them to handle different incident notifications using either custom or predefined notification templates.

Configuring the webhook alert method​

You can configure your webhook alert method directly in the Nobl9 UI, or by applying a YAML file in sloctl.

Nobl9 Web​

To set up the alert method on the Nobl9 Web, follow these steps:

  1. Navigate to Integrations > Alert methods.
  2. Click .
  3. Select Webhook.

  1. Enter the URL (mandatory).
    Your webhook endpoint HTTP POST requests will be sent to.
    The URL must start with https://.

  2. Select a Project.
    Project is a way to organize your Nobl9 resources and manage access to them.
    When Project is skipped, Nobl9 uses the default project.
  3. Enter a Display Name.
    You can enter a user-friendly name with spaces in this field.
  4. Enter a Name.
    The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example, my-alert-method-1). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result.
  5. You can add Description to your resource, providing extra details about it, its purpose, responsible persons, etc.
    Up to 1050 characters.

  6. In the Custom Header block, you can add customized headers to be sent along with Webhook notifications. To add a custom header:

    1. Click blue plus icon.
    2. Enter Key and Value
      • For Key, use only letters, numbers, hyphens (-), and underscores (_). It must start with a letter or number.

  7. Configure Notification Details to define the details to be included in the response payload. Select between the following options:

    • Nobl9: select at least one field from the list of predefined details.

    • Custom: create a custom payload or click Insert to use templated field values. Only JSON is accepted:

      • Enclose each field name in double quotes ("<field_name>")
      • Indicate variables with $, use lowercase letters, and separate words with _
      • When you expect to receive an array, add square brackets ([]) after the value
      For example
          {
          "policy": $alert_policy_conditions[],
          "message": "Your SLO $slo_name needs attention!"
          }
  8. Click Add alert method.

YAML configuration​

YAML for the webhook integration supports custom notification message templates. The template can be specified in two ways:

  • Only variables are specified, and the notification message is generated automatically
  • A full message template is specified, with variables in the form $<variable_name>
General YAML sample for Webhook alert method
apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: string # Mandatory
  displayName: string # Optional
  project: default # Mandatory
  # Optional
  # The key value: only alphanumeric characters, `-`, `_`, or `.` are allowed.
  # The key value must start and end with an alphanumeric character.
  # An optional DNS subdomain prefix followed by `/` is allowed.
  annotations:
    key: value
spec:
  description: string # Optional
  webhook:
    url: string # Mandatory, must start with https://
    # Either `templateFields` or `template` must be specified, but not both.
    templateFields: # array of strings
      - string1
      - string2
    # Replace the `templateFields` with `template` if a full template is used
    # template: string

Important notes:

  • In your Webhook YAML definition, define either of the following objects:

    • spec.webhook.template

    • spec.webhook.templateFields

  • The difference between alert_policy_conditions[] and alert_policy_conditions_text is that alert_policy_conditions[] creates a valid JSON array of conditions as strings, whereas alert_policy_conditions_text creates a single string field. For example:

    {
      "text": "Remaining error budget is 10%, Error budget would be exhausted in 15 minutes and this condition lasts for 1 hour",
      "array": [
        "Remaining error budget is 10%",
        "Error budget would be exhausted in 15 minutes and this condition lasts for 1 hour"
      ]
    }

  • slo_labels_text, service_labels_text, and alert_policy_labels_text are comma-separated key:value pairs. For example:

    • slo:ratio, slo:calendar

    • project:myproject

    • alert:low, alert:high

Testing the webhook alert policy in the UI​

You can test alert methods for all notification services supported by the Nobl9 platform through the UI.

To verify the correctness of your alert method configuration:

  1. Navigate to Integrations > Alert methods.
  2. Click the required alert method.
    Its Details page opens.
  3. Click Test under the alert method name:

    • When the configuration is correct, Nobl9 displays Test completed successfully! under the button.
    • Otherwise, the Test failed message appears. It contains the details of incorrect settings.
For a more in-depth look, consult additional resources:
Webhook alert methodTerraform provider
Last updated on
On this page