Interface: DynamicTriggerData

Data for a DynamicTrigger as returned by the backend: the DynamicTriggerCreateData configuration supplemented with the assigned identifier.

Properties

arguments?

optional arguments?: DynamicTriggerArgumentSchema;

Present only for triggers created with an explicit argument schema.

---

authorization_level?

optional authorization_level?: KappappsRoleType;

Minimum role required to fire the trigger.

---

color?

optional color?: string;

Color associated with the trigger.

---

cooldown?

optional cooldown?: number;

Global cooldown (in seconds) between two activations.

---

cost?

optional cost?: number;

Cost in internal currency to fire the trigger.

---

description?

optional description?: string;

Display description of the trigger.

---

id

id: number;

Unique identifier of the trigger.

---

interval_duration?

optional interval_duration?: number;

Interval duration (in seconds) for a trigger of type INTERVAL.

---

keyword?

optional keyword?: string;

Keyword / command that activates the trigger (depending on the type).

---

max_per_player_per_stream?

optional max_per_player_per_stream?: number;

Maximum number of activations per player per stream.

---

max_per_stream?

optional max_per_stream?: number;

Maximum number of activations per stream.

---

needs_input?

optional needs_input?: boolean;

Whether a Twitch reward asks Twitch to collect user input.

---

prompt?

optional prompt?: string;

Prompt text shown to the user when input is required.

---

title

title: string;

Display title normalized by the server (at most 25 characters, 45 for a TWREW).

---

type

type: DynamicTriggerType;

Trigger type (see DynamicTriggerType).

---

user_cooldown?

optional user_cooldown?: number;

Cooldown (in seconds) applied per user.