twitch / trigger / schema v1
New Subscription
Fires when someone subscribes to the channel
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. |
Ignore Gifted SubsignoreGifts | boolean Optional | Skip subs that were gifted (the Gift Subscription trigger covers those) |
Minimum TierminimumTier | select Optional | Only trigger for subs at or above this tier Options: Tier 1 (or Prime) (1000), Tier 2 (2000), Tier 3 (3000) |
Inputs and outputs
Inputs
No ports declared.
Outputs
on_event- On New Subscription (output)user_id- User ID (output)username- Username (output)display_name- Display Name (output)tier- Subscription Tier (1000/2000/3000) (output)is_gift- Is Gifted (output)message- Sub Message (output)streak_months- Streak Months (output)cumulative_months- Cumulative Months (output)
Output data schema
[
{
"key": "user_id",
"type": "string",
"description": "User ID",
"label": "User ID",
"bindingRole": "event_subject"
},
{
"key": "username",
"type": "string",
"description": "Username",
"label": "Username",
"bindingRole": "event_subject"
},
{
"key": "display_name",
"type": "string",
"description": "Display Name",
"label": "Display Name",
"bindingRole": "event_subject"
},
{
"key": "tier",
"type": "string",
"description": "Subscription Tier (1000/2000/3000)",
"label": "Subscription Tier (1000/2000/3000)"
},
{
"key": "is_gift",
"type": "boolean",
"description": "Is Gifted",
"label": "Is Gifted"
},
{
"key": "message",
"type": "string",
"description": "Sub Message",
"label": "Sub Message",
"optional": true
},
{
"key": "streak_months",
"type": "number",
"description": "Streak Months",
"label": "Streak Months",
"optional": true
},
{
"key": "cumulative_months",
"type": "number",
"description": "Cumulative Months",
"label": "Cumulative Months",
"optional": true
}
]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
351651bf3c815d3bbff80bce49cf84649dc1fd539ccac1e10a93e653e1fe8331