Skip to main content
Corvus Connection

On Goal Begin

TwitchTrigger
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
outExecexecNone
typeDataSystem.Stringmultiplexed
descriptionDataSystem.Stringmultiplexed
currentAmountDataSystem.Int32multiplexed
targetAmountDataSystem.Int32multiplexed
startedAtDataSystem.DateTimemultiplexed

Bindings

Name
Type
Description
typeSystem.StringThe goal type (e.g. follower, subscription, or bits).
descriptionSystem.StringThe creator's description of the goal.
currentAmountSystem.Int32The goal's current amount.
targetAmountSystem.Int32The amount that completes the goal.
startedAtSystem.DateTimeWhen the goal started (UTC).

Parameters

Name
Type
Required
Default
Choices
cooldownSecondsSystem.Int32no0None
perUserCooldownSecondsSystem.Int32no0None
debounceMsSystem.Int32no0None
dedupeKeySystem.Stringno""None
maxConcurrencySystem.Int32no0None

Lowers to C#

[OnGoalBegin] Handle(ctx, GoalContext e)