Uploaded image for project: 'Camunda Optimize'
  1. Camunda Optimize
  2. OPT-4278

Decompose existing alert message into multiple webhook parameters to create more expressive alerts

XMLWordPrintable

    • 1
    • S
    • 3 - Expected

      User Story
      When I receive an alert via webhook, I want to view more data about the alert's configuration so I can better understand the context of my alert.

      What is the desired functionality that you are missing?

      Offer the possibility to use additional parameters within the defaultPayload configuration, as e.g. AlertName, RelatedReport Link and Name, Current Value, Threshould Value.

      Which problem are you going to solve with this functionality?

      When using Alerts with Webhooks today it is relatively challenging to customize the message that is being send to the target system since it is all part of "ALERT_MESSAGE". At the same time certain parameters like e.g. "Alert Name", "Related Report (Link)", "Current Value", "Threshould Value" might be useful for creating a custom message.

      One customer wants to translate from English to Spanish, so they just want to extract the key values (SUPPORT-8560)

      Another customer is trying to set severity, which is done through analyzing the elements of the webhook (e.g. which alert, how bad is the violation. etc) (SUPPORT-8307)

       

      GIVEN I have created an alert
      AND the alert is subscribed through a webhook
      THEN the user has the option to extract alert configuration data from the ALERT_MESSAGE (in addition to ALERT MESSAGE)
      WHEN the webhook triggers
      THEN alert configuration's data is available (see screenshots)

      New Placeholders:

      • ALERT_NAME, sample value "Some Alert"
      • ALERT_REPORT_LINK, sample value "http://https://stage.optimize.camunda.cloud/#/report/b4a8ec72-55b1-46a2-b944-c9bd314e0b7b/"
      • ALERT_CURRENT_VALUE, sample value "400"
      • ALERT_THRESHOLD_VALUE, sample value "100"
      • ALERT_THRESHOLD_OPERATOR, sample value "<" OR ">"
      • ALERT_TYPE, with the values values "new", "reminder", "resolved" indicating whether this alert is freshly triggered, a reminder or actually resolved
      • ALERT_INTERVAL, sample value "5"
      • ALERT_INTERVAL_UNIT, sample value "minutes"

        This is the controller panel for Smart Panels app

              Unassigned Unassigned
              felix.mueller Felix Mueller
              Sebastian Bathke Sebastian Bathke
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: