Origins¶
The Talkable Origins API allows the registration of ‘off-site’ or ‘backend’ purchases or CRM events so they can be used in the referral flow. This functionality is generally utilized by businesses using subscription billing, off-site transactions, or other off-site events.
Note
The standard front-end Talkable integration will capture all one-time purchases happening on the client e-commerce site, but will not on its own capture purchases or CRM events happening on the backend. To do this, the Origins API must be utilized to feed ‘off-site’ or ‘backend’ purchases or CRM events to Talkable.
Example use cases for the Origins API
Subscription:
A company whose customers sign up for a monthly service by making an initial ‘on-site’ payment, then are charged monthly on the backend for subsequent subscription payments. This company would like to reward Advocate users (referrers) with a reward after their Friend has been a member for three billing cycles.
Talkable’s standard front-end integration captures the initial ‘on-site’ payment.
For Talkable to reward the Advocate after the third billing cycle of the Friend subscription, the Company must pass the subsequent subscription data to Talkable’s Origins API using
"type": "Event"
.
Off-Site Events:
A company whose customers purchase product or perform events off-site. This company would like to reward Advocate users (referrers) with a reward after their Friend has purchased a product in the brick and mortar store, or attended an in-person appointment.
Talkable’s standard front-end integration captures an initial ‘on-site’ signup event if there is one.
For Talkable to reward the Advocate after the in-person Friend store purchase, or appointment attendance, the Company must pass the in-store purchase, or appointment attendance data to Talkable’s Origins API with either
"type": "Purchase"
for a purchase or"type": "Event"
for an appointment attendance.
User Approval:
User approval use cases start with customers who need to submit an application by performing an initial ‘on-site’ sign-up event. This company would like to reward Advocate users (referrers) with a reward after their Friend application is approved.
Talkable’s standard front-end integration captures the initial ‘on-site’ application sign-up event.
In order for Talkable to reward the Advocate after the Friend application approval, the Company must pass the approval data to Talkable’s Origins API using
"type": "Event"
.