OWN3D Developer Portal
Analyzer
Documentation
Status
Discord
Customer Support
GitHub
Analyzer
Documentation
Status
Discord
Customer Support
GitHub
  • API Documentation

    • Introduction
    • OWN3D Pro API
    • OWN3D Shop API
    • Developer Guidelines
  • OWN3D ID

    • Authorization
    • Webhooks
    • ID API Reference
    • Account Migration
  • OWN3D Extensions

    • Getting Started
    • Manifest Configuration
    • Life Cycle Management
    • Access Control
    • Extension SDK
    • Usage of Tokens
    • Remote Config
    • Syntax for Forms
    • Designing Extensions
    • Guidelines and Policies
  • OWN3D Cloud

    • Edge Functions
    • Key-Value Store
  • OWN3D NotifySub

    • Getting Started
    • Subscribing and Unsubscribing
    • Event Types
  • OWN3D Alerts

    • Getting Started
    • Message Template Parameters
    • Alert Variations
    • Examples
  • OWN3D Pro Chatbot

    • Getting Started
    • Auto Mod
    • Timers
    • Giveaways
    • Command Settings
    • Custom Commands
    • Template Reference
    • All Commands
  • OWN3D Music

    • DDEX

Alert Variations AE4

An alert variation is a specific configuration that defines how an alert should appear for a particular scenario. Each variation has its own set of conditions and overrides.

We use JsonLogic to define alert variation conditions. Conditions are used to determine which variation should be used for a given alert. They are defined using logical operators and compare variables to specific values.

List of Global Variables AE4

The following variables are available for use in alert variation conditions for all alert types:

VariableDescription
typeThe type of alert.
platformThe type of alert.
enabledWhether the alert is enabled.
randomA random number between 1 and 100.

List of Alert Type Specific Variables AE4

Technically you can combine all Message Template Parameters as variables in your alert variation conditions. For example, you can use amount to compare the amount of a donation or name to compare the name of the person who triggered the alert.

You can also find a list of existing parameters for each alert type using the resources/alert-variations.json api endpoint.

Here is an example of an alert variation configuration for a Twitch Cheer alert:

{
  "name": "Twitch Cheer",
  "conditions": {
    "and": [
      {"===": [{"var": "type"}, "cheer"]},
      {"===": [{"var": "platform"}, "twitch"]},
      {"===": [{"var": "enabled"}, true]},
      {">=": [{"var": "amount"}, 1000]}
    ]
  },
  "overrides": {
    "title": "Thanks {{name}} for cheering over 1K bits!💃💃💃"
  }
}
Edit this page on GitHub
Prev
Message Template Parameters
Next
Examples