Reward Webhook¶
The Talkable Reward Webhook notifies your endpoint that a reward is ready to be, or has been given. A reward can be for either an Advocate or for a Friend. Talkable Reward Webhook notifications allow your application to know when to reward users by means other than the standard ‘give them a coupon code’ method.
Use cases for the Reward Webhook include:
Providing account credit or account upgrades to a user as a reward
Giving non-monetary rewards such as physical gifts
Sending automated ‘Thank You’ emails after a reward is given to a user
Any event that should trigger at the moment a user has earned a reward
When does Talkable call the Reward Webhook?
Talkable calls the Reward Webhook any time a reward is ready to be, or has been given to either an Advocate or a Friend according to the logic set-up in a Talkable referral campaign.
Possible events which will trigger the Reward Webhook are:
Advocate Signup Form submitted (Reason = signup)
Advocate shares an offer with Friend(s) (Reason = shared)
Friend passes email gating form (Reason = click)
Note
If campaign is setup without email gating form, Reward Webhook with Reason = click will trigger when Friend clicks through to site.
Friend makes eligible purchase (Reason = referrer)
Friend makes eligible purchase (Reason = referred)
Note
Reason = referrer indicates a reward should be given to an Advocate. Reason = referred indicates a reward should be given to a Friend.
Set-Up
Because the Reward Webhook will trigger at various events depending on the Incentive configuration for each referral campaign, to trigger the Reward Webhook we first must ensure Incentives are correctly configured. To configure incentives:
Navigate to Campaigns then select the campaign you would like to configure incentives for
Proceed to Rules then scroll down to Incentives section where incentives for both Advocates and Friends can be set-up
Configure the incentives as desired inside the Referral Incentive Editor. To configure Incentive types other than Coupon Codes, please contact your Talkable Customer Success Manager; they will be able to set up “Rebate (store credit)” type incentives and “Non-Monetary” type incentives.
Note
If there is a delay configured into when the Advocate reward is approved then the Reward Webhook trigger when the Advocate reward is ready to be, or has been given. For example, if campaigns are set to send an Advocate their reward three days after a Friend makes an eligible purchase, then the Reward Webhook will be called three days after the Friend makes the eligible purchase. You can select these delays under Fraud Settings, which is found under Menu.
Once incentives are configured for a referral campaign, Talkable will then call the Reward Webhook any time either an Advocate or a Friend should receive a reward. Now, the Reward Webhook can be set-up. Learn more about General Webhook Set Up Steps
Payload parameters provided by Reward Webhook
campaign — subhash of parameters describing the campaign
id — unique campaign ID
cached_slug — same as id, SEO friendly
type — either “StandaloneCampaign” or “DoubleSidedDealCampaign”
new_customer — whether the Advocate has to be a new customer to see the campaign
origin_min_age — seconds passed since the first site visit before the Advocate can see the campaign
origin_max_age — seconds passed since the first site visit during which the Advocate can see the campaign
joinable_category_names — categories of origins that trigger the campaign
tag_names — array of campaign’s tags
offer — subhash of parameters describing the offer
email — Advocate’s (referrer) email address
short_url_code
ip_address
person — subhash of parameters describing the person that got reward (note: might be null)
email — person’s email address
phone_number — person’s phone number (optional)
first_name — person’s first name (optional)
last_name — person’s last name (optional)
username — person’s username (optional)
sub_choice — subscription choice (optional, present only if the form included subscription checkbox)
subscribed_at — date person has subscribed (deprecated; use
opted_in_atinstead)opted_in_at — date person has subscribed (optional)
phone_opted_in_at — date person has subscribed with email (optional)
unsubscribed_at — date person has unsubscribed with phone number (optional)
custom_properties — hash of person’s custom properties (optional)
is_loyalty_member — whether the person participates in loyalty program
loyalty_member — details of the person as a loyalty program participant (optional)
referral_counts — referral counts of person as Advocate
total — created referrals count
approved — approved referrals count
pending — count of waiting for approval referrals
gender [deprecated]
origin — subhash of data related to the event that issued an offer
type
“Purchase” for post-purchase placement
“AffiliateMember” for standalone, floating widget, or gleam placements
- “Event” for post-event placement (such as a signup/share page which triggers a
referral campaign)
id — unique identifier of the origin event
email — email address of the person
customer_id — unique external identifier of a customer who triggered the origin event
traffic_source — traffic source of the origin event
ip_address — IP address of the origin event
For Purchase:
order_number — unique identifier of the Purchase
subtotal — order subtotal for the Purchase
currency_iso_code — currency code of the Purchase, defaults to the Site’s currency
coupon_code — coupon codes used with the Purchase (separated by
,if multiple)order_date — date of the Purchase
For Event:
event_category — identifier of an action that trigger the Event (e.g.
app_installed)event_number — unique identifier of the Event within the associated event_category
subtotal — optional monetary attribute of the Event
currency_iso_code — currency code of the Event, defaults to the Site’s currency
coupon_code — coupon codes used with the Event (separated by
,if multiple)
reward — subhash of parameters describing the reward itself
id — unique identifier of the reward
reason — reason why this reward was given
status — status of the reward (i.e. “Paid”, “Unpaid”, “Voided”)
incentive_type — type of incentive (rebate, discount_coupon, other)
incentive_identifier — unique human-readable identifier of the incentive
incentive_description — description of incentive (human-readable, equals to non monetary description if incentive_type is other)
amount — amount of money to reward (null when incentive_type is discount_coupon or other)
coupon_code — deprecated in favor of coupon
coupon — reward coupon details (null when incentive_type is rebate or other)
active — true if the coupon has not expired yet
amount — amount of the discount that the coupon provides
code — unique coupon code
description — human-readable representation of the discount (e.g. “$15” or “10%”)
id — unique identifier of the coupon
percentage_discount — true if the coupon amount is percentage as opposed to a fixed value
single_use — true if the coupon is single-use
usages — number of times the coupon has been used (null if the coupon is multi-use)
used — true if the coupon has been used
expires_at — expiration time of the coupon (deprecated)
valid_until — expiration time of the coupon in the site time zone
advocate_origin — subhash of data related to the Advocate origin
type
“Purchase” for post-purchase placement
“AffiliateMember” for standalone, floating widget, or gleam placements
- “Event” for post-event placement (such as a signup/share page which triggers a
referral campaign)
id — unique identifier of the origin event
email — email address of the person
customer_id — unique external identifier of a customer who triggered the origin event
traffic_source — traffic source of the origin event
ip_address — IP address of the origin event
For Purchase:
order_number — unique identifier of the Purchase
subtotal — order subtotal for the Purchase
currency_iso_code — currency code of the Purchase, defaults to the Site’s currency
coupon_code — coupon codes used with the Purchase (separated by
,if multiple)order_date — date of the Purchase
For Event:
event_category — identifier of an action that trigger the Event (e.g.
app_installed)event_number — unique identifier of the Event within the associated event_category
subtotal — optional monetary attribute of the Event
currency_iso_code — currency code of the Event, defaults to the Site’s currency
coupon_code — coupon codes used with the Event (separated by
,if multiple)
friend_origin — subhash of data related to the Friend origin
type
“Purchase” for post-purchase placement
“AffiliateMember” for standalone, floating widget, or gleam placements
- “Event” for post-event placement (such as a signup/share page which triggers a
referral campaign)
id — unique identifier of the origin event
email — email address of the person
customer_id — unique external identifier of a customer who triggered the origin event
traffic_source — traffic source of the origin event
ip_address — IP address of the origin event
For Purchase:
order_number — unique identifier of the Purchase
subtotal — order subtotal for the Purchase
currency_iso_code — currency code of the Purchase, defaults to the Site’s currency
coupon_code — coupon codes used with the Purchase (separated by
,if multiple)order_date — date of the Purchase
For Event:
event_category — identifier of an action that trigger the Event (e.g.
app_installed)event_number — unique identifier of the Event within the associated event_category
subtotal — optional monetary attribute of the Event
currency_iso_code — currency code of the Event, defaults to the Site’s currency
coupon_code — coupon codes used with the Event (separated by
,if multiple)
Reasons
Reward reason can be of 5 following general types.
signup — Advocate reward for sign-up (Advocate Signup Form submitted)
shared — Advocate reward for sharing an offer with Friend(s)
click — Friend reward for visiting claim page (and optionally passing gating)
referrer — Advocate reward for eligible referral purchase by Friend
referred — Friend reward for eligible referral purchase by themselves
Incentive types
Incentives can be of 3 following general types.
Rebate (rebate) — monetary reward, certain amount of money that should be paid out to a customer with a given email. The merchants’ payment system should handle the payment.
Coupon code (discount_coupon) — a discount coupon is issued to user. Talkable handles distributing this type of incentives.
Non-monetary (other) — used when a campaign has a non-monetary rebate like “Free T-shirt” or “One Month Free”. This should be handled on the merchant’s side. More information on the reward is specified in incentive_description.
Coupon codes as a reward
Important
If referral campaigns are set-up to reward either Friends or Advocates with Talkable provided coupon codes, then the Reward Webhook is called for informational purposes only. It is a notification that the reward has been provided. Note, Talkable gets these coupons either by manual upload from the Dashboard, or if configured, Talkable will call the Create Coupon Webhook to generate additional coupons automatically.
Sample payload | Reason = signup
{
"person": {
"email": "referrer@example.com",
"phone_number": "+12025551111",
"first_name": "Bob",
"last_name": "Smith",
"username": null,
"unsubscribed_at": null,
"opted_in_at": null,
"phone_opted_in_at": null,
"sub_choice": false,
"subscribed_at": null,
"custom_properties": {},
"referral_counts": {"total": 0, "approved": 0, "pending": 0},
"is_loyalty_member": false,
"loyalty_member": null,
"gender": null
},
"origin": {
"id": 186742865,
"type": "AffiliateMember",
"email": "referrer@example.com",
"customer_id": "910930418",
"ip_address": "127.0.0.1",
"traffic_source": "unknown"
},
"advocate_origin": {
"id": 186742865,
"type": "AffiliateMember",
"email": "referrer@example.com",
"customer_id": "910930418",
"ip_address": "127.0.0.1",
"traffic_source": "unknown"
},
"friend_origin": null,
"campaign": {
"id": 500548529,
"type": "StandaloneCampaign",
"cached_slug": 500548529,
"tag_names": ["default"],
"joinable_category_names": ["affiliate_member"],
"origin_min_age": null,
"origin_max_age": null,
"new_customer": null
},
"offer": {
"email": "referrer@example.com",
"short_url_code": "1a2PV",
"ip_address": "127.0.0.1"
},
"reward": {
"id": 8261257,
"reason": "signup",
"incentive_type": "discount_coupon",
"incentive_identifier": "signup",
"incentive_description": "signup coupon \"SAMPLE-COUPON-CODE\" for $10.00 off",
"incentive_custom_description": null,
"amount": 10.0,
"coupon": {
"code": "SAMPLE-COUPON-CODE",
"active": true,
"valid_until": null,
"single_use": false,
"used": false,
"usages": null,
"amount": 10.0,
"percentage_discount": null,
"description": "$10",
"id": 60477154,
"expires_at": null
},
"coupon_code": "SAMPLE-COUPON-CODE",
"status": "Paid"
}
}
cURL example | Reason = signup
curl <url> \
-d "key=<key>" \
-d "site=<site>" \
-d "type=reward_web_hook" \
-d "extras={}" \
-d 'payload={"person":{"email":"referrer@example.com","phone_number":"+12025551111","first_name":"Bob","last_name":"Smith","username":null,"unsubscribed_at":null,"opted_in_at":null,"phone_opted_in_at":null,"sub_choice":false,"subscribed_at":null,"custom_properties":{},"referral_counts":{"total":0,"approved":0,"pending":0},"is_loyalty_member":false,"loyalty_member":null,"gender":null},"origin":{"id":186742865,"type":"AffiliateMember","email":"referrer@example.com","customer_id":"910930418","ip_address":"127.0.0.1","traffic_source":"unknown"},"advocate_origin":{"id":186742865,"type":"AffiliateMember","email":"referrer@example.com","customer_id":"910930418","ip_address":"127.0.0.1","traffic_source":"unknown"},"friend_origin":null,"campaign":{"id":500548529,"type":"StandaloneCampaign","cached_slug":500548529,"tag_names":["default"],"joinable_category_names":["affiliate_member"],"origin_min_age":null,"origin_max_age":null,"new_customer":null},"offer":{"email":"referrer@example.com","short_url_code":"1a2PV","ip_address":"127.0.0.1"},"reward":{"id":8261257,"reason":"signup","incentive_type":"discount_coupon","incentive_identifier":"signup","incentive_description":"signup coupon \"SAMPLE-COUPON-CODE\" for $10.00 off","incentive_custom_description":null,"amount":10.0,"coupon":{"code":"SAMPLE-COUPON-CODE","active":true,"valid_until":null,"single_use":false,"used":false,"usages":null,"amount":10.0,"percentage_discount":null,"description":"$10","id":60477154,"expires_at":null},"coupon_code":"SAMPLE-COUPON-CODE","status":"Paid"}}'
Sample payload | Reason = shared
{
"person": null,
"origin": {
"id": 186742865,
"type": "AffiliateMember",
"email": "referrer@example.com",
"customer_id": "910930418",
"ip_address": "127.0.0.1",
"traffic_source": "unknown"
},
"advocate_origin": {
"id": 186742865,
"type": "AffiliateMember",
"email": "referrer@example.com",
"customer_id": "910930418",
"ip_address": "127.0.0.1",
"traffic_source": "unknown"
},
"friend_origin": null,
"campaign": {
"id": 500548529,
"type": "StandaloneCampaign",
"cached_slug": 500548529,
"tag_names": ["default"],
"joinable_category_names": ["affiliate_member"],
"origin_min_age": null,
"origin_max_age": null,
"new_customer": null
},
"offer": {
"email": "referrer@example.com",
"short_url_code": "1a2PV",
"ip_address": "127.0.0.1"
},
"reward": {
"id": 8260964,
"reason": "shared",
"incentive_type": "discount_coupon",
"incentive_identifier": "sharing",
"incentive_description": "shared coupon \"SAMPLE-COUPON-CODE\" for $10.00 off",
"incentive_custom_description": null,
"amount": 10.0,
"coupon": {
"code": "SAMPLE-COUPON-CODE",
"active": true,
"valid_until": null,
"single_use": false,
"used": false,
"usages": null,
"amount": 10.0,
"percentage_discount": null,
"description": "$10",
"id": 60477154,
"expires_at": null
},
"coupon_code": "SAMPLE-COUPON-CODE",
"status": "Paid"
}
}
cURL example | Reason = shared
curl <url> \
-d "key=<key>" \
-d "site=<site>" \
-d "type=reward_web_hook" \
-d "extras={}" \
-d 'payload={"person":null,"origin":{"id":186742865,"type":"AffiliateMember","email":"referrer@example.com","customer_id":"910930418","ip_address":"127.0.0.1","traffic_source":"unknown"},"advocate_origin":{"id":186742865,"type":"AffiliateMember","email":"referrer@example.com","customer_id":"910930418","ip_address":"127.0.0.1","traffic_source":"unknown"},"friend_origin":null,"campaign":{"id":500548529,"type":"StandaloneCampaign","cached_slug":500548529,"tag_names":["default"],"joinable_category_names":["affiliate_member"],"origin_min_age":null,"origin_max_age":null,"new_customer":null},"offer":{"email":"referrer@example.com","short_url_code":"1a2PV","ip_address":"127.0.0.1"},"reward":{"id":8260964,"reason":"shared","incentive_type":"discount_coupon","incentive_identifier":"sharing","incentive_description":"shared coupon \"SAMPLE-COUPON-CODE\" for $10.00 off","incentive_custom_description":null,"amount":10.0,"coupon":{"code":"SAMPLE-COUPON-CODE","active":true,"valid_until":null,"single_use":false,"used":false,"usages":null,"amount":10.0,"percentage_discount":null,"description":"$10","id":60477154,"expires_at":null},"coupon_code":"SAMPLE-COUPON-CODE","status":"Paid"}}'
Sample payload | Reason = click
{
"person": null,
"origin": null,
"advocate_origin": {
"id": 395950177,
"type": "AffiliateMember",
"email": "referrer@example.com",
"customer_id": "180484020",
"ip_address": "127.0.0.1",
"traffic_source": "unknown"
},
"friend_origin": null,
"campaign": {
"id": 312538309,
"type": "StandaloneCampaign",
"cached_slug": 312538309,
"tag_names": ["default"],
"joinable_category_names": ["affiliate_member"],
"origin_min_age": null,
"origin_max_age": null,
"new_customer": null
},
"offer": {
"email": "referrer@example.com",
"short_url_code": "1a2PV",
"ip_address": "127.0.0.1"
},
"reward": {
"id": 8261304,
"reason": "click",
"incentive_type": "discount_coupon",
"incentive_identifier": "click",
"incentive_description": "shared coupon \"SAMPLE-COUPON-CODE\" for $10 off",
"incentive_custom_description": null,
"amount": 10.0,
"coupon": {
"code": "SAMPLE-COUPON-CODE",
"active": true,
"valid_until": null,
"single_use": false,
"used": false,
"usages": null,
"amount": 10.0,
"percentage_discount": null,
"description": "$10",
"id": 60477154,
"expires_at": null
},
"coupon_code": "SAMPLE-COUPON-CODE",
"status": "Paid"
}
}
cURL example | Reason = click
curl <url> \
-d "key=<key>" \
-d "site=<site>" \
-d "type=reward_web_hook" \
-d "extras={}" \
-d 'payload={"person":null,"origin":null,"advocate_origin":{"id":395950177,"type":"AffiliateMember","email":"referrer@example.com","customer_id":"180484020","ip_address":"127.0.0.1","traffic_source":"unknown"},"friend_origin":null,"campaign":{"id":312538309,"type":"StandaloneCampaign","cached_slug":312538309,"tag_names":["default"],"joinable_category_names":["affiliate_member"],"origin_min_age":null,"origin_max_age":null,"new_customer":null},"offer":{"email":"referrer@example.com","short_url_code":"1a2PV","ip_address":"127.0.0.1"},"reward":{"id":8261304,"reason":"click","incentive_type":"discount_coupon","incentive_identifier":"click","incentive_description":"shared coupon \"SAMPLE-COUPON-CODE\" for $10 off","incentive_custom_description":null,"amount":10.0,"coupon":{"code":"SAMPLE-COUPON-CODE","active":true,"valid_until":null,"single_use":false,"used":false,"usages":null,"amount":10.0,"percentage_discount":null,"description":"$10","id":60477154,"expires_at":null},"coupon_code":"SAMPLE-COUPON-CODE","status":"Paid"}}'
Sample payload | Reason = referrer
{
"person": {
"first_name": "Bob",
"last_name": "Smith",
"email": "referrer@example.com",
"phone_number": "+12025551111",
"username": "username",
"unsubscribed_at": null,
"subscribed_at": "2018-08-27T21:42:23.060+03:00",
"opted_in_at": "2018-08-27T21:42:23.060+03:00",
"phone_opted_in_at": "2018-08-27T21:42:23.060+03:00",
"sub_choice": true,
"referral_counts": {
"total": 0,
"approved": 0,
"pending": 0
},
"custom_properties": {},
"is_loyalty_member": false,
"loyalty_member": null,
"gender": null
},
"origin": {
"id": 280695079,
"type": "Purchase",
"order_number": "288015920",
"order_date": "2018-08-27T21:45:29.519+03:00",
"subtotal": 6.31,
"currency_iso_code": "USD",
"email": "referrer@example.com",
"customer_id": "230652117",
"ip_address": "127.0.0.1",
"coupon_code": "WHT25279",
"traffic_source": "post-checkout"
},
"advocate_origin": {
"id": 280695079,
"type": "Purchase",
"order_number": "288015920",
"order_date": "2018-08-27T21:45:29.519+03:00",
"subtotal": 6.31,
"currency_iso_code": "USD",
"email": "referrer@example.com",
"customer_id": "230652117",
"ip_address": "127.0.0.1",
"coupon_code": "WHT25279",
"traffic_source": "post-checkout"
},
"friend_origin": {
"id": 264084636,
"type": "Purchase",
"order_number": "4190583",
"order_date": "2018-08-27T21:45:29.519+03:00",
"subtotal": 73.41,
"currency_iso_code": "USD",
"email": "referred@example.com",
"customer_id": "323518374",
"ip_address": "127.0.0.1",
"coupon_code": "WHT40052",
"traffic_source": "post-checkout"
},
"campaign": {
"id": 484002505,
"type": "StandaloneCampaign",
"cached_slug": 484002505,
"tag_names": ["default"],
"joinable_category_names": ["purchase"],
"origin_min_age": null,
"origin_max_age": null,
"new_customer": null
},
"offer": {
"email": "referrer@example.com",
"short_url_code": "1a2PV",
"ip_address": "127.0.0.1"
},
"reward": {
"id": 8261305,
"reason": "referrer",
"incentive_type": "rebate",
"incentive_identifier": "referrer",
"incentive_description": "$10.00 back",
"incentive_custom_description": null,
"amount": 10.0,
"coupon": {},
"coupon_code": null,
"status": "Paid"
}
}
cURL example | Reason = referrer
curl <url> \
-d "key=<key>" \
-d "site=<site>" \
-d "type=reward_web_hook" \
-d "extras={}" \
-d 'payload={"person":{"first_name":"Bob","last_name":"Smith","email":"referrer@example.com","phone_number":"+12025551111","username":"username","unsubscribed_at":null,"subscribed_at":"2018-08-27T21:42:23.060+03:00","opted_in_at":"2018-08-27T21:42:23.060+03:00","phone_opted_in_at":"2018-08-27T21:42:23.060+03:00","sub_choice":true,"referral_counts":{"total":0,"approved":0,"pending":0},"custom_properties":{},"is_loyalty_member":false,"loyalty_member":null,"gender":null},"origin":{"id":280695079,"type":"Purchase","order_number":"288015920","order_date":"2018-08-27T21:45:29.519+03:00","subtotal":6.31,"currency_iso_code":"USD","email":"referrer@example.com","customer_id":"230652117","ip_address":"127.0.0.1","coupon_code":"WHT25279","traffic_source":"post-checkout"},"advocate_origin":{"id":280695079,"type":"Purchase","order_number":"288015920","order_date":"2018-08-27T21:45:29.519+03:00","subtotal":6.31,"currency_iso_code":"USD","email":"referrer@example.com","customer_id":"230652117","ip_address":"127.0.0.1","coupon_code":"WHT25279","traffic_source":"post-checkout"},"friend_origin":{"id":264084636,"type":"Purchase","order_number":"4190583","order_date":"2018-08-27T21:45:29.519+03:00","subtotal":73.41,"currency_iso_code":"USD","email":"referred@example.com","customer_id":"323518374","ip_address":"127.0.0.1","coupon_code":"WHT40052","traffic_source":"post-checkout"},"campaign":{"id":484002505,"type":"StandaloneCampaign","cached_slug":484002505,"tag_names":["default"],"joinable_category_names":["purchase"],"origin_min_age":null,"origin_max_age":null,"new_customer":null},"offer":{"email":"referrer@example.com","short_url_code":"1a2PV","ip_address":"127.0.0.1"},"reward":{"id":8261305,"reason":"referrer","incentive_type":"rebate","incentive_identifier":"referrer","incentive_description":"$10.00 back","incentive_custom_description":null,"amount":10.0,"coupon":{},"coupon_code":null,"status":"Paid"}}'
Sample payload | Reason = referred
{
"person": {
"first_name": "Matt",
"last_name": "Smith",
"email": "referred@example.com",
"phone_number": null,
"username": "username",
"unsubscribed_at": null,
"subscribed_at": "2018-08-27T21:45:29.519+03:00",
"opted_in_at": "2018-08-27T21:45:29.519+03:00",
"phone_opted_in_at": null,
"sub_choice": true,
"referral_counts": {
"total": 0,
"approved": 0,
"pending": 0
},
"custom_properties": {},
"is_loyalty_member": false,
"loyalty_member": null,
"gender": null
},
"origin": {
"id": 818629076,
"type": "Purchase",
"order_number": "416466456",
"order_date": "2018-08-27T21:45:29.519+03:00",
"subtotal": 48.39,
"currency_iso_code": "USD",
"email": "referred@example.com",
"customer_id": "401088820",
"ip_address": "127.0.0.1",
"coupon_code": "WHT862",
"traffic_source": "post-checkout"
},
"advocate_origin": {
"id": 77856467,
"type": "Purchase",
"order_number": "529868349",
"order_date": "2018-08-27T21:45:29.519+03:00",
"subtotal": 25.76,
"currency_iso_code": "USD",
"email": "referrer@example.com",
"customer_id": "937735146",
"ip_address": "127.0.0.1",
"coupon_code": "WHT15105",
"traffic_source": "post-checkout"
},
"friend_origin": {
"id": 818629076,
"type": "Purchase",
"order_number": "416466456",
"order_date": "2018-08-27T21:45:29.519+03:00",
"subtotal": 48.39,
"currency_iso_code": "USD",
"email": "referred@example.com",
"customer_id": "401088820",
"ip_address": "127.0.0.1",
"coupon_code": "WHT862",
"traffic_source": "post-checkout"
},
"campaign": {
"id": 944706822,
"type": "StandaloneCampaign",
"cached_slug": 944706822,
"tag_names": ["default"],
"joinable_category_names": ["purchase"],
"origin_min_age": null,
"origin_max_age": null,
"new_customer": null
},
"offer": {
"email": "referrer@example.com",
"short_url_code": "1a2PV",
"ip_address": "127.0.0.1"
},
"reward": {
"id": 8261300,
"reason": "referred",
"incentive_type": "rebate",
"incentive_identifier": "referred",
"incentive_description": "$10.00 back",
"incentive_custom_description": null,
"amount": 10.0,
"coupon": {},
"coupon_code": null,
"status": "Paid"
}
}
cURL example | Reason = referred
curl <url> \
-d "key=<key>" \
-d "site=<site>" \
-d "type=reward_web_hook" \
-d "extras={}" \
-d 'payload={"person":{"first_name":"Matt","last_name":"Smith","email":"referred@example.com","phone_number":null,"username":"username","unsubscribed_at":null,"subscribed_at":"2018-08-27T21:45:29.519+03:00","opted_in_at":"2018-08-27T21:45:29.519+03:00","phone_opted_in_at":null,"sub_choice":true,"referral_counts":{"total":0,"approved":0,"pending":0},"custom_properties":{},"is_loyalty_member":false,"loyalty_member":null,"gender":null},"origin":{"id":818629076,"type":"Purchase","order_number":"416466456","order_date":"2018-08-27T21:45:29.519+03:00","subtotal":48.39,"currency_iso_code":"USD","email":"referred@example.com","customer_id":"401088820","ip_address":"127.0.0.1","coupon_code":"WHT862","traffic_source":"post-checkout"},"advocate_origin":{"id":77856467,"type":"Purchase","order_number":"529868349","order_date":"2018-08-27T21:45:29.519+03:00","subtotal":25.76,"currency_iso_code":"USD","email":"referrer@example.com","customer_id":"937735146","ip_address":"127.0.0.1","coupon_code":"WHT15105","traffic_source":"post-checkout"},"friend_origin":{"id":818629076,"type":"Purchase","order_number":"416466456","order_date":"2018-08-27T21:45:29.519+03:00","subtotal":48.39,"currency_iso_code":"USD","email":"referred@example.com","customer_id":"401088820","ip_address":"127.0.0.1","coupon_code":"WHT862","traffic_source":"post-checkout"},"campaign":{"id":944706822,"type":"StandaloneCampaign","cached_slug":944706822,"tag_names":["default"],"joinable_category_names":["purchase"],"origin_min_age":null,"origin_max_age":null,"new_customer":null},"offer":{"email":"referrer@example.com","short_url_code":"1a2PV","ip_address":"127.0.0.1"},"reward":{"id":8261300,"reason":"referred","incentive_type":"rebate","incentive_identifier":"referred","incentive_description":"$10.00 back","incentive_custom_description":null,"amount":10.0,"coupon":{},"coupon_code":null,"status":"Paid"}}'