Events and actions

An action defines what an app does when a Talkable event occurs. For example, an email opt-in can subscribe a person to a list, and a reward event can send reward details to an external tool. Available actions depend on the app.

Enable only the actions you need. For automatic event delivery, both the app and the action must be enabled, and the action’s trigger criteria must match. Use Testing a connection before starting automatic sending.

Event data

Each event supplies its own Liquid variables. Use these in payload attributes and trigger criteria. On an enabled action, click Show available variables below the payload table to see its fields.

The table summarizes event families; it does not mean every app offers every action. Custom App provides notifications for the event families below. Other apps expose the actions relevant to their integration.

Event	When it occurs	Main variables
Sign-up	An advocate or friend signs up; consent is separate from signing up	person, ip, campaign, site_id
Email or phone opt-in	A person opts in to the corresponding channel	person, ip, campaign, site_id
Unsubscribe	A person unsubscribes from Talkable emails	person, campaign, site_id
Offer share	An advocate shares an offer	sharer, sharer_origin, campaign, site, type, channel_identifier; recipient for email shares
Referral created or status changed	A referral is created or its status changes	advocate_person, friend_person, referral, offer, referred_origin, campaign, site
Reward	A reward is paid, excluding loyalty points	person (the recipient), coupon, incentive, origin, campaign, offer, site; referral for referral rewards
Coupon creation	Talkable generates a coupon to send to your store	coupon, coupon_list, site
Purchase or event	A new Purchase or Event is registered	origin, person, site; no campaign
Refund	A refund is created	refund, origin, site
Loyalty action	A loyalty member performs an action	member_info, action; no campaign
Loyalty tier change	A member changes loyalty tier	member_info, tier_transition; no campaign
Wallet pass installation	A person’s pass is registered with no other device registrations; replaces the wallet welcome email. Requires a campaign offer and no wallet-install email verification. See Wallet install events and welcome emails	person, pass, offer, campaign, site

Choosing the right person variable

Use the person associated with the event you are filtering. For an opt-in or reward, this is person. For an offer share, it is sharer. A referral contains both advocate_person and friend_person; choose whose data your rule needs. Loyalty events use member_info.

For example, a country property on an opt-in action is person.custom_properties.country. On an offer-share action, use sharer.custom_properties.country instead. See Custom properties.

Purchases and custom events

Custom App’s Event action sends both registered purchases and other events. Use origin.type to distinguish Purchase from Event, and origin.event_category for the category supplied by your integration. Both types provide origin.event_number, origin.subtotal, and origin.currency_iso_code.

A custom event does not create a new App Store action for each category. Use the Event action and filter the categories you need with trigger criteria. It has no campaign variable; filter on the event or person data instead.

Actions that check a response

Custom App also provides two actions that read a result from your endpoint:

Action	Purpose	Main variables
Click reward verification	Check a friend’s eligibility when they attempt to claim a click reward	friend_info, campaign, site
Check Unsubscribed	Check an external unsubscribe state before Talkable sends an email	person, campaign, site_id, email_type

These actions need a response format and timeout appropriate to the check. See Custom App response checks.

App-specific actions

Some apps also provide inbound data-sync or other specialized actions. Their settings differ from outbound event actions, and a data-sync action does not have the payload editor or sample-send controls described in these guides. Use the settings and descriptions shown on that action.