Groups triggers¶
Group added¶
Runs when a new, empty group of viewers is created. Groups are lists of viewers, like "Trusted", made on the Users & Groups page or with an action.
| Setting | What to put in |
|---|---|
| Group | The group's name. Empty means any group. |
Variables you get
| Variable | What it holds |
|---|---|
%groupName% |
The name of the group |
Type id: groups.added
Group cleared¶
Runs when every viewer is taken out of a group at once, but the group itself stays.
| Setting | What to put in |
|---|---|
| Group | The group's name. Empty means any group. |
Variables you get
| Variable | What it holds |
|---|---|
%groupName% |
The name of the group |
%count% |
How many viewers were taken out |
Type id: groups.cleared
Group removed¶
Runs when a group of viewers is deleted.
| Setting | What to put in |
|---|---|
| Group | The group's name. Empty means any group. |
Variables you get
| Variable | What it holds |
|---|---|
%groupName% |
The name of the group |
Type id: groups.removed
Users added to group¶
Runs when a viewer is put into a group. Good for welcoming someone to "VIPs" or "Trusted".
| Setting | What to put in |
|---|---|
| Group | The group's name. Empty means any group. |
Variables you get
| Variable | What it holds |
|---|---|
%groupName% |
The name of the group |
%user% |
The viewer who was added |
%userId% |
The viewer's id on their platform |
%platform% |
The site the viewer is on, like twitch |
Type id: groups.usersAdded
Users removed from group¶
Runs when a viewer is taken out of a group.
| Setting | What to put in |
|---|---|
| Group | The group's name. Empty means any group. |
Variables you get
| Variable | What it holds |
|---|---|
%groupName% |
The name of the group |
%user% |
The viewer who was removed |
%userId% |
The viewer's id on their platform |
%platform% |
The site the viewer is on, like twitch |
Type id: groups.usersRemoved