Incentive

Preview

Documentation Needed

This section is missing documentation. If you know how to use this feature, please consider contributing!

Contribute on GitHub

Parameters

DonorDriverequired

Select

Choose a configured DonorDrive Provider

Select Any to trigger on any provider

Variables

The following variables will be populated when this trigger executes:

		Description
`donorAmount`	`number`	The amount that the donor has given Example: `10`
`donorAvatarUrl`	`string`	The URL of the donor's avatar
`donorIsAnonymous`	`boolean`	Is the donor anonymous? Example: `true`
`donorMessage`	`string`	The message of the donor
`donorName`	`string`	The name of the donor
`eventName`	`string`	The name of the event
`goal`	`number`	The total goal Example: `200`
`incentive.amount`	`number`	The amount of the incentive. Example: `10`
`incentive.description`	`string`	The description of the incentive.
`incentive.endDate`	`DateTime`	The timestamp this incentive ends. Example: `8/4/2023 10:56:06 AM`
`incentive.id`	`string`	The id of this incentive.
`incentive.image`	`string`	The image for the incentive. Can be an empty string.
`incentive.isActive`	`boolean`	Is the incentive active? Example: `true`
`incentive.links.donate`	`string`	The url of the donate link.
`incentive.quantity`	`number`	The quantity of the incentive. Can be -1. Example: `5`
`incentive.quantityClaimed`	`number`	The amount of claimed quantity. Example: `2`
`incentive.startDate`	`DateTime`	The timestamp this incentive starts. Example: `8/4/2023 10:56:06 AM`
`isIncentive`	`boolean`	Is the event an incentive? Example: `true`
`isParticipant`	`boolean`	Is the user a participant? Example: `true`
`isTeam`	`boolean`	Is this a team? Example: `true`
`profileName`	`string`	The name of the profile
`profileTeamName`	`string`	The name of the profile's team
`raised`	`number`	The total amount of money that has been raised Example: `100`
`recipientName`	`string`	The broadcaster's name used in the DonorDrive

		Description
`__source`	`EventType`	The event which triggered the action. This will not always exist and requires C# to access, read more Example: `TwitchChatMessage`
`actionId`	`Guid`	The unique ID of the action being executed Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`actionName`	`string`	The name of the action being executed Example: `My Action`
`actionQueuedAt`	`DateTime`	The timestamp of when action was queued Example: `12/21/2023 9:25:21 AM`
`eventSource`	`EventSource`	The service of the event which triggered the action. This will not always exist and requires C# to access, read more Example: `twitch`
`runningActionId`	`Guid`	The unique ID of this running action instance within the queue Example: `c83dd939-9f86-4435-b07c-b6e7e3eef134`
`triggerCategory`	`string`	The category of the trigger which executed the action Example: `Twitch/Chat`
`triggerId`	`Guid`	The unique id of the trigger with executed the action Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`triggerName`	`string`	The name of the trigger which executed the action Example: `Chat Message`

Donation

Trigger for a DonorDrive Donation

Profile Updated

Trigger for when your DonorDrive Profile is Updated