twitch / trigger / schema v1
User Banned / Timed Out
Fires when a user is banned or timed out
Prerequisites
- Add the twitch plugin inside this workflow.
- Connect and authorize a twitch account before running this node.
Parameters
| Parameter | Type | Description |
|---|---|---|
Channelchannel | twitch_self Required | Triggers only on your connected Twitch channel. |
Ban TypebanType | select Optional | Leave empty to trigger on both Options: Permanent bans only (permanent), Timeouts only (timeout) |
Inputs and outputs
Inputs
No ports declared.
Outputs
on_event- On User Banned / Timed Out (output)user_id- Banned User ID (output)username- Banned Username (output)moderator_id- Moderator ID (output)moderator_username- Moderator Username (output)reason- Ban Reason (output)ends_at- Timeout Ends At (null = permanent ban) (output)is_permanent- Is Permanent Ban (output)
Output data schema
[
{
"key": "user_id",
"type": "string",
"description": "Banned User ID",
"label": "Banned User ID",
"bindingRole": "event_subject"
},
{
"key": "username",
"type": "string",
"description": "Banned Username",
"label": "Banned Username",
"bindingRole": "event_subject"
},
{
"key": "moderator_id",
"type": "string",
"description": "Moderator ID",
"label": "Moderator ID",
"bindingRole": "actor"
},
{
"key": "moderator_username",
"type": "string",
"description": "Moderator Username",
"label": "Moderator Username",
"bindingRole": "actor"
},
{
"key": "reason",
"type": "string",
"description": "Ban Reason",
"label": "Ban Reason",
"optional": true
},
{
"key": "ends_at",
"type": "string",
"description": "Timeout Ends At (null = permanent ban)",
"label": "Timeout Ends At (null = permanent ban)",
"optional": true
},
{
"key": "is_permanent",
"type": "boolean",
"description": "Is Permanent Ban",
"label": "Is Permanent Ban"
}
]Examples and troubleshooting have not yet been reviewed for this contract.
Version and compatibility
This reference follows the current authoring contract. Existing workflows retain their saved node revisions.
Contract identifier
09f547cebcb43e569e4ce7800a6b4c08913c9f71c3150c346b05459dd3481a19