Attentive Custom Events List

"Inveterate: Welcome" Custom Event

Triggered when a customer signs up for your membership program. In the email, they should prompted to create an account in your store or sign in to use their membership benefits.

Event Properties

NameDescriptionExampleTemplate Syntax

tierName

Name of membership

"Acme Gold"

{{triggerEvent.custom['tierName']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
 <head></head>
 <body>
  <p>Welcome to {{triggerEvent.custom['tierName'] | default: ' '}}, an exclusive membership program created by YOUR_STORE_NAME.</p>
  <p>In order to access all your membership benefits, please take a moment to login or create your account.</p>
  <p><a rel="nofollow" href="YOUR_STORES_CUSTOMER_ACCOUNT_PAGE_LINK">Open my account</a></p>
  <p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
  <p>YOUR_COMPANY_NAME</p>
  <p>{{companyAddress}}</p>
 </body>
</html>

SMS Text Template Example

Welcome to {{triggerEvent.custom['tierName']}}! In order to access all your membership benefits, please take a moment to login or create your account at www.Website.com

"Inveterate: Payment Failure" Custom Event

Triggered when a customer's rebill fails due to a credit card issue.

Event Properties

NameDescriptionExampleTemplate Syntax

finalAttemptDate

Final date when Inveterate will try to rebill the member, after which their membership will be cancelled.

Aug 9, 2023

{{triggerEvent.custom['finalAttemptDate']}}

tierName

Name of membership

"Acme Gold"

{{triggerEvent.custom['tierName']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
 <head></head>
 <body>
  <p>Your payment method has failed</p>
  <p>We'll try again for the next few days. To continue being a part of {{triggerEvent.custom['tierName']}}, please make sure your payment details are up to date.</p>
  <p>If your payment isn’t successful on {{triggerEvent.custom['finalAttemptDate']}}, your membership will be cancelled.</p>
  <p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
  <p>YOUR_COMPANY_NAME</p>
  <p>{{companyAddress}}</p>
 </body>
</html>

SMS Text Template Example

We are unable to process your payment for {{triggerEvent.custom['tierName']}}, please update your billing info by {{triggerEvent.custom['finalAttemptDate']}}.

"Inveterate: Cancellation Notice" Custom Event

Triggered when a member cancels their membership, when they churn due to a billing issue, or when the merchant cancels the member from the Inveterate dashboard.

Event Properties

NameDescriptionExampleTemplate Syntax

cancellationDate

The effective cancellation date when customer loses access to benefits

Aug 9, 2023 or blank

{{triggerEvent.custom['cancellationDate']}}

cancellationPolicy

Whether benefit access ends instantly or at the end of the billing cycle

"immediately" or "end of billing cycle"

{{triggerEvent.custom['cancellationPolicy']}}

tierName

Name of membership

"Acme Gold"

{{triggerEvent.custom['tierName']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
 <head></head>
 <body>
  <p>You've cancelled {{triggerEvent.custom['tierName'] | default: ' '}} on {{triggerEvent.custom['cancellationDate']}}</p>
  <p>Your access to benefits will end {{triggerEvent.custom['cancellationPolicy']}}</p>
  <p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
  <p>YOUR_COMPANY_NAME</p>
  <p>{{companyAddress}}</p>
 </body>
</html>

SMS Text Template Example

You've cancelled {{triggerEvent.custom['tierName']}} on {{triggerEvent.custom['cancellationDate']}}, Your access to {{triggerEvent.custom['tierName']}} benefits will end {{triggerEvent.custom['cancellationPolicy']}}

"Inveterate: Rebill Notice" Custom Event

Triggered when a member is reminded that their rebill is going to happen soon.

NameDescriptionExampleTemplate Syntax

cancellationPolicy

Whether benefit access ends instantly or at the end of the billing cycle

"immediately" or "end of billing cycle"

{{triggerEvent.custom['cancellationPolicy']}}

rebillFrequency

How often a membership rebill occurs

"monthly", "quarterly", "semi-annually", "annually"

{{triggerEvent.custom['rebillFrequency']}}

rebillDate

The date when the member will be rebilled

"Aug 20, 2024" or blank

{{triggerEvent.custom['rebillDate']}}

rebillPrice

The price that the member will be rebilled

$24.99, $25.00

{{triggerEvent.custom['rebillPrice']}}

supportEmail

Your support email address

help@merchant.com

{{triggerEvent.custom['supportEmail']}}

tierName

Name of the tier the member is in

"Acme Gold"

{{triggerEvent.custom['tierName']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
 <head></head>
 <body>
  <p>Your renewal for {{triggerEvent.custom['tierName']}}</p>
  <p>Thank you for your continued participation in our exclusive membership program! As a reminder, your membership is set to renew on {{triggerEvent.custom['rebillDate']}} for a total of {{triggerEvent.custom['rebillPrice']}}, plus any applicable sales tax.</p>
  <p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
  <p>YOUR_COMPANY_NAME</p>
  <p>{{companyAddress}}</p>
 </body>
</html>

SMS Text Example

You will be billed {{triggerEvent.custom['rebillPrice']}} for your {{triggerEvent.custom['tierName']}} membership on {{triggerEvent.custom['rebillDate']}}. Reach out to {{triggerEvent.custom['supportEmail']}} with any questions.

"Inveterate: Membership Change" Custom Event

Triggered when a member upgrades or downgrades their membership tier.

Event Properties

NameDescriptionExampleTemplate Syntax

newTierName

The new tier the member has enrolled into

"Acme Gold"

{{triggerEvent.custom['newTierName']}}

newTierPrice

The price of the new tier the member has enrolled into

$24.99, $25.00

{{triggerEvent.custom['newTierPrice']}}

oldTierName

The old their the member was enrolled into

"Acme Silver"

{{triggerEvent.custom['oldTierName']}}

oldTierPrice

The price of the old tier the member was enrolled into

$24.99, $25.00

{{triggerEvent.custom['oldTierPrice']}}

tierChangeQuality

Whether the member has upgraded or downgraded their membership

"upgrade" or "downgrade"

{{triggerEvent.custom['tierChangeQuality']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
 <head></head>
 <body>
  <p>You've upgraded your membership</p>
  <p>Your {{triggerEvent.custom['tierName'] | default: ' '}} membership has been upgraded to {{triggerEvent.custom['newTierName']}}. Your new membership price is now {{triggerEvent.custom['newTierPrice']}}.</p>
  <p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
  <p>YOUR_COMPANY_NAME</p>
  <p>{{companyAddress}}</p>
 </body>
</html>

SMS Template Example

You've {{triggerEvent.custom['tierChangeQuality']}}d {{triggerEvent.custom['oldTierName']}} to {{triggerEvent.custom['newTierName']}}. Your rebill amount will change from {{triggerEvent.custom['oldTierPrice']}} to {{triggerEvent.custom['newTierPrice']}}.

"Inveterate: Anniversary Credits" Custom Event

Triggered when a member is awarded credits according to the Anniversary Credits benefit.

NameDescriptionExampleTemplate Syntax

creditsAwarded

Amount of new credits awarded

"$10.00", "$9.99"

{{triggerEvent.custom['creditsAwarded']}}

newCreditsBalance

Balance after credits awarded.

"$10.00", "$9.99"

{{triggerEvent.custom['newCreditsBalance']}}

tierName

Name of membership

"Acme Gold"

{{triggerEvent.custom['tierName']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
<head></head>
<body>
<p>
  You have been a loyal member of {{triggerEvent.custom['tierName'] | default: ' '}} for a year!
</p>
<p>
  To show our appreciation, we've awarded you {{triggerEvent.custom['creditsAwarded'] in store credits! You now have a total of {{triggerEvent.custom['newCreditsBalance'] | default: ''}} that you can redeem for purchases since you’re a member of {{triggerEvent.custom['tierName'] | default: 'our program'}}.
</p>
<p>
  <a href="LINK_TO_YOUR_STOREFRONT">Shop now</a>
</p>
<p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
<p>YOUR_COMPANY_NAME</p>
<p>{{companyAddress}}</p>
</body>
</html>

SMS Template Example

We just awarded you {{triggerEvent.custom['creditsAwarded']}} for being a {{triggerEvent.custom['tierName']}} member for a year, your new balance is {{triggerEvent.custom['newCreditsBalance']}}

"Inveterate: Credits Redeemed" Custom Event

Triggered when a customer completes an order that used redeemed credits.

Event Properties

NameDescriptionExampleTemplate Syntax

creditsRedeemed

Number of credits used in order

$24.99, $25.00

{{triggerEvent.custom['creditsRedeemed']

newCreditsBalance

Credits member now has left

$0.99, $1.00

{{triggerEvent.custom['newCreditsBalance']}}

tierName

Name of membership

"Acme Gold"

{{triggerEvent.custom['tierName']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
 <head></head>
 <body>
  <p>
    You just redeemed {{triggerEvent.custom['tierName'] | default: ' '}} at YOUR_STORE_NAME!
  </p>
  <p>
    You just redeemed credits for a purchase. You now have {{triggerEvent.custom['newCreditsBalance'] | default: ' '}} remaining in your account.
  </p>
  <p>
    Thanks for being a part of {{triggerEvent.custom['tierName'] | default: ' '}},
  </p>
  <p>
    YOUR_STORE_NAME
  </p>
  <p>
    <a href="YOUR_STORES_CUSTOMER_ACCOUNT_PAGE_LINK">View my account</a>
  </p>
  <p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
  <p>YOUR_COMPANY_NAME</p>
  <p>{{companyAddress}}</p>
</body>
</html>

SMS Text Template Example

You just used {{triggerEvent.custom['creditsRedeemed']}} in credits and have {{triggerEvent.custom['newCreditsBalance']}} left. Thanks for being a part of {{triggerEvent.custom['tierName']}}

"Inveterate: Signup Discount" Custom Event

Triggered after a sign up discount code has been generated for a new member, with instructions on how to use it.

Event Properties

NameDescriptionExampleTemplate Syntax

discountCode

Unique sign up discount code created for each member

"VIP_123"

{{triggerEvent.custom['discountCode']}}

isPercentage

Is the discount a percent amount off a future order

true or false

{{triggerEvent.custom['isPercentage']}}

isFixed

Is the discount a fixed dollar amount

true or false

{{triggerEvent.custom['isFixed']}}

discountAmount

How much off an order is the discount

$10.00, 20%

{{triggerEvent.custom['discountAmount']}}

isOneTimeUse

Is the discount disabled after 1 use, or can it be used multiple times

true or false

{{triggerEvent.custom['isOneTimeUse']}}

expirationDate

If the discount code expires, when

"Aug 8, 2024" or blank

{{triggerEvent.custom['expirationDate']}}

tierName

Name of membership

"Acme Gold"

{{triggerEvent.custom['tierName']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
<head></head>
<body>
<p>
  Here’s your personal member discount code, {{subscriber.firstName | default: 'valued customer'}}!
</p>
<p>
  As a valued member of {{triggerEvent.custom['tierName'] | default: 'our program'}}, we’ve created a personal discount code just for you! It’s your chance to take advantage of these VIP savings.
</p>
<p>
  Get {{triggerEvent.custom['discountAmount'] | default: ''}} off using this code at checkout: {{triggerEvent.custom['discountCode'] | default: ''}}.
</p>  
<p>
  One time use. Expires {{triggerEvent.custom['prettyExpirationDate'] | default: 'soon'}}.
</p>
<p>
  <a href="LINK_TO_YOUR_STOREFRONT">Shop now</a>
</p>
<p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
<p>YOUR_COMPANY_NAME</p>
<p>{{companyAddress}}</p>
</body>
</html>

SMS Text Template Example

{{triggerEvent.custom['discountCode']}} is your discount code. Use this code to save {{triggerEvent.custom['discountAmount']}} before {{triggerEvent.custom['expirationDate']}}.

"Inveterate: Credits Awarded" Custom Event

Email triggered when a member has earned new store credits due to the following benefits: Credits for Orders, Recurring Store Credits, or Signup Store Credits.

Event Properties

NameDescriptionExampleTemplate Syntax

creditsAwarded

Amount of new credits awarded

"$10.00", "$9.99"

{{triggerEvent.custom['creditsAwarded']}}

newCreditsBalance

Balance after credits awarded.

"$10.00", "$9.99"

{{triggerEvent.custom['newCreditsBalance']}}

tierName

Name of membership

"Acme Gold"

{{triggerEvent.custom['tierName']}}

reason

Reason member earned credits, e.g. name of benefit

"credits for order", "recurring store credit", "signup store credits"

{{triggerEvent.custom['reason']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
<head></head>
<body>
<p>
  You've just received {{triggerEvent.custom['creditsAwarded'] | default: ''}} in store credit.
</p>
<p>
  You now have a total of {{triggerEvent.custom['newCreditsBalance'] | default: ''}} that you can redeem for purchases since you’re a member of {{triggerEvent.custom['tierName'] | default: 'our program'}}.
</p>
<p>
  <a href="LINK_TO_YOUR_STOREFRONT">Shop now</a>
</p>
<p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
<p>YOUR_COMPANY_NAME</p>
<p>{{companyAddress}}</p>
</body>
</html>

SMS Text Template Example

You just received {{triggerEvent.custom['creditsAwarded']}} in credits from the {{triggerEvent.custom['reason']}} benefit. Your balance is now {{triggerEvent.custom['newCreditsBalance']}}.

"Inveterate: Credits Expiring" Custom Event

Triggered when some amount of a member's credits are expiring soon.

Event Properties

NameDescriptionExampleTemplate Syntax

creditsExpiring

Amount of credits expiring

"$23.32"

{{triggerEvent.custom['creditsExpiring']}}

daysLeft

Days until credits expire

15 days, 1 day

{{triggerEvent.custom['daysLeft']}}

tierName

Name of membership

"Acme Gold"

{{triggerEvent.custom['tierName']}}

Email Template Example

<p>
  You have {{triggerEvent.custom['creditsExpiring'] | default: ''}} that expire in {{triggerEvent.custom['daysLeft'] | default: ''}}.
</p>
<p>
  Head back to our site to check out what's new and put those credits to good use.
</p>
<p>
  <a href="LINK_TO_YOUR_STOREFRONT">Redeem my credits</a>
</p>

SMS Text Template Example

You have {{triggerEvent.custom['creditsExpiring']}} in credits that expire in {{triggerEvent.custom['daysLeft']}}. Thanks for being part of {{triggerEvent.custom['tierName']}}

"Inveterate: Referral Completed" Custom Event

Triggered when a member completes a successful referral according to the referral benefit.

NameDescriptionExampleTemplate Syntax

creditsAwarded

Amount of new credits awarded

"$10.00", "$9.99"

{{triggerEvent.custom['creditsAwarded']

newCreditsBalance

Balance after credits awarded.

"$10.00", "$9.99"

{{triggerEvent.custom['newCreditsBalance']

tierName

Name of membership

"Acme Gold"

{{triggerEvent.custom['tierName']

referredEmail

Email of member that was referred

member@gmail.com

{{triggerEvent.custom['referredEmail']}}

Email Template Example

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
<head></head>
<body>
<p>
  {{triggerEvent.custom['referredEmail']}} just joined {{triggerEvent.custom['tierName'] | default: ' '}} because you referred them!
</p>
<p>
As a thank you, we've added `{{triggerEvent.custom['creditsAwarded'] into your account. You now have a total of {{triggerEvent.custom['newCreditsBalance'] | default: ''}} that you can redeem for purchases since you’re a member of {{triggerEvent.custom['tierName'] | default: 'our program'}}.
</p>
<p>
  <a href="LINK_TO_YOUR_STOREFRONT">Shop now</a>
</p>
<p><a href="{{unsubscribeLink}}">Unsubscribe</a></p>
<p>YOUR_COMPANY_NAME</p>
<p>{{companyAddress}}</p>
</body>
</html>

SMS Text Template

You referred {{triggerEvent.custom['referredEmail']}} and earned {{triggerEvent.custom['creditsAwarded']}} in store credit. You have {{triggerEvent.custom['newCreditsBalance']}} in store credit. Thanks for being a part of {{triggerEvent.custom['tierName']}}
PreviousHow to Create Journeys in Attentive with Inveterate's Custom EventsNextMemberships 101

Last updated