Skip to main content
Corvus Connection

On Goal Begin

Twitch
Trigger
entry.onGoalBeginFires when a creator goal starts. Binds the goal type, description, and its current and target amounts.Triggers when a creator goal begins.Requires the channel:read:goals scope.
EngagementLifecycle

Outputs

Name
Kind
Type
Flags
out
Exec
exec
None
type
Data
System.String
multiplexed
description
Data
System.String
multiplexed
currentAmount
Data
System.Int32
multiplexed
targetAmount
Data
System.Int32
multiplexed
startedAt
Data
System.DateTime
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    type
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    description
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    currentAmount
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    targetAmount
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    startedAt
    Kind
    Data
    Type
    System.DateTime
    Flags
    multiplexed

Bindings

Name
Type
Description
type
System.String
The goal type (e.g. follower, subscription, or bits).
description
System.String
The creator's description of the goal.
currentAmount
System.Int32
The goal's current amount.
targetAmount
System.Int32
The amount that completes the goal.
startedAt
System.DateTime
When the goal started (UTC).
  • Name
    type
    Type
    System.String
    Description
    The goal type (e.g. follower, subscription, or bits).
  • Name
    description
    Type
    System.String
    Description
    The creator's description of the goal.
  • Name
    currentAmount
    Type
    System.Int32
    Description
    The goal's current amount.
  • Name
    targetAmount
    Type
    System.Int32
    Description
    The amount that completes the goal.
  • Name
    startedAt
    Type
    System.DateTime
    Description
    When the goal started (UTC).

Parameters

Name
Type
Required
Default
Choices
cooldownSeconds
System.Int32
no
0
None
perUserCooldownSeconds
System.Int32
no
0
None
debounceMs
System.Int32
no
0
None
dedupeKey
System.String
no
""
None
maxConcurrency
System.Int32
no
0
None
  • Name
    cooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    perUserCooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    debounceMs
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    dedupeKey
    Type
    System.String
    Required
    no
    Default
    ""
    Choices
    None
  • Name
    maxConcurrency
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None

Lowers to C#

[OnGoalBegin] Handle(ctx, GoalContext e)