Segment Threshold Alert

Notifies when a segment-based alert triggers. Alerts can trigger when the active users in a saved segment cross a configured threshold.

The "duration" field in the "alertConfig" section of the payload will be "DAILY", "WEEKLY", or "MONTHLY", based on whether the alert was configured to examine daily active users vs. weekly or monthly active users. The "direction" field, also in the "alertConfig" section, will be either "ABOVE" or "BELOW", based on whether the alert triggers when the observed value goes above or below the configured threshold.

note

When configuring an endpoint that receives this type of event, you can configure which particular alert(s) will be delivered to the endpoint. If you have not created any alerts, they will not show up as an option when configuring a webhook endpoint.

note

Alerts is an Enterprise pricing feature. See pricing page for more details.

Event API Name

segment.trend.alert

Example Payload

{
  "eventName": "segment.trend.alert",
  "version": 1,
  "data": {
    "id": "a5fe758dc531089a203b20b0",
    "timestamp": "2019-04-21T19:06:44.927Z",
    "value": 114,
    "notificationUrl": "https://app.fullstory.com/ui/TN1/segments/daniel@falko.co:5758531089203200/searchie/SearchieDailyActives:%7B%22Actives%22%3A%5B1%5D%2C%22ComputePast%22%3Afalse%2C%22ComputeRatio%22%3Afalse%2C%22AlignWeekdays%22%3Afalse%7D/alerts/5640204417302528/notifications/4922830298873856",
    "alertConfig": {
      "description": "too many people abandoning checkout",
      "threshold": 100,
      "direction": "ABOVE",
      "duration": "DAILY",
      "alertUrl": "https://app.fullstory.com/ui/TN1/segments/daniel@falko.co:5758531089203200/searchie/SearchieDailyActives:%7B%22Actives%22%3A%5B1%5D%2C%22ComputePast%22%3Afalse%2C%22ComputeRatio%22%3Afalse%2C%22AlignWeekdays%22%3Afalse%7D/alerts/5640204417302528",
      "alertCreator": "daniel@falko.co",
      "segmentUrl": "https://app.fullstory.com/ui/TN1/segments/daniel@falko.co:5758531089203200",
      "segmentCreator": "daniel@falko.co",
      "segmentName": "Cancelled checkout flow"
    }
  }
}