Reference Triggers Ko Fi

Ko-fi triggers

Also on the Cuebot Docs site.

Commission

Runs when someone pays for a Ko-fi commission (a custom piece of work). Needs your Ko-fi webhook set up.

Setting	What to put in
Minimum amount	The smallest amount that runs this. Example: 5 ignores anything under 5. Leave 0 to run for any amount. Amounts are not converted between currencies. Starts as: 0.
Maximum amount (0 = no limit)	The biggest amount that runs this. Leave 0 for no upper limit. Starts as: 0.
Currencies	Only run for these currencies. Type the short codes with commas, like "USD, EUR". Leave empty for every currency.
Include test events	Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true.

Variables you get

Variable	What it holds
%user%	Who supported you ("Anonymous" if hidden)
%amount%	The amount as a number, like 5 or 12.5
%currency%	The currency code, like USD
%formattedAmount%	The amount written nicely, like "$5.00"
%message%	Their message
%url%	A web link to the Ko-fi page of this support
%isTest%	True when this is a test event, not a real one

Type id: kofi.commission

Donation

Runs when someone sends you a one-off Ko-fi donation. Needs your Ko-fi webhook set up on the Webhooks page.

Setting	What to put in
Minimum amount	The smallest amount that runs this. Example: 5 ignores anything under 5. Leave 0 to run for any amount. Amounts are not converted between currencies. Starts as: 0.
Maximum amount (0 = no limit)	The biggest amount that runs this. Leave 0 for no upper limit. Starts as: 0.
Currencies	Only run for these currencies. Type the short codes with commas, like "USD, EUR". Leave empty for every currency.
Include test events	Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true.

Variables you get

Variable	What it holds
%user%	Who supported you ("Anonymous" if hidden)
%amount%	The amount as a number, like 5 or 12.5
%currency%	The currency code, like USD
%formattedAmount%	The amount written nicely, like "$5.00"
%message%	Their message
%url%	A web link to the Ko-fi page of this support
%isTest%	True when this is a test event, not a real one

Type id: kofi.donation

Resubscription

Runs when a Ko-fi member pays again for their membership. Needs your Ko-fi webhook set up.

Setting	What to put in
Tier name	Only run for this membership level, like "Gold". Type it as it appears on your page. Leave empty for any level.
Minimum amount	The smallest amount that runs this. Example: 5 ignores anything under 5. Leave 0 to run for any amount. Amounts are not converted between currencies. Starts as: 0.
Maximum amount (0 = no limit)	The biggest amount that runs this. Leave 0 for no upper limit. Starts as: 0.
Currencies	Only run for these currencies. Type the short codes with commas, like "USD, EUR". Leave empty for every currency.
Include test events	Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true.

Variables you get

Variable	What it holds
%user%	Who supported you ("Anonymous" if hidden)
%amount%	The amount as a number, like 5 or 12.5
%currency%	The currency code, like USD
%formattedAmount%	The amount written nicely, like "$5.00"
%message%	Their message
%url%	A web link to the Ko-fi page of this support
%isTest%	True when this is a test event, not a real one
%tier%	Their membership level

Type id: kofi.resubscription

Shop Order

Runs when someone buys from your Ko-fi shop. Handy to thank buyers on stream. Needs your Ko-fi webhook set up.

Setting	What to put in
Minimum amount	The smallest amount that runs this. Example: 5 ignores anything under 5. Leave 0 to run for any amount. Amounts are not converted between currencies. Starts as: 0.
Maximum amount (0 = no limit)	The biggest amount that runs this. Leave 0 for no upper limit. Starts as: 0.
Currencies	Only run for these currencies. Type the short codes with commas, like "USD, EUR". Leave empty for every currency.
Include test events	Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true.

Variables you get

Variable	What it holds
%user%	Who supported you ("Anonymous" if hidden)
%amount%	The amount as a number, like 5 or 12.5
%currency%	The currency code, like USD
%formattedAmount%	The amount written nicely, like "$5.00"
%message%	Their message
%url%	A web link to the Ko-fi page of this support
%isTest%	True when this is a test event, not a real one
%itemCount%	How many different items were ordered
%item0%	The first item's name (use item1, item2... for the next ones)
%item0.quantity%	How many of the first item

Type id: kofi.shopOrder

Subscription

Runs when someone starts a new Ko-fi membership with you. Needs your Ko-fi webhook set up.

Setting	What to put in
Tier name	Only run for this membership level, like "Gold". Type it as it appears on your page. Leave empty for any level.
Minimum amount	The smallest amount that runs this. Example: 5 ignores anything under 5. Leave 0 to run for any amount. Amounts are not converted between currencies. Starts as: 0.
Maximum amount (0 = no limit)	The biggest amount that runs this. Leave 0 for no upper limit. Starts as: 0.
Currencies	Only run for these currencies. Type the short codes with commas, like "USD, EUR". Leave empty for every currency.
Include test events	Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true.

Variables you get

Variable	What it holds
%user%	Who supported you ("Anonymous" if hidden)
%amount%	The amount as a number, like 5 or 12.5
%currency%	The currency code, like USD
%formattedAmount%	The amount written nicely, like "$5.00"
%message%	Their message
%url%	A web link to the Ko-fi page of this support
%isTest%	True when this is a test event, not a real one
%tier%	The membership level they joined

Type id: kofi.subscription