Advocate Signup Webhook¶
The Talkable Advocate Signup Webhook notifies your endpoint of an Advocate Signup forms submission.
Use cases for the Advocate Signup Webhook include:
Tracking when users select the checkbox to opt into your email newsletter
Collection of data for Business Intelligence and analytics systems to track users who become Advocates
Sending automated ‘Thank You’ emails after a user becomes an Advocate
When does Talkable call the Advocate Signup Webhook?
Talkable Signup Webhook is triggered any time an Advocate Signup Form is submitted. The Advocate Signup Form is the standard Name & Email (with optional email subscription checkbox) fields a user submits before becoming an Advocate and sharing an offer with Friends.
Advocate Signup Form example:

Payload parameters provided for Advocate Signup Webhook
offer — subhash of parameters describing the offer
email — Advocate’s (referrer) email address
short_url_code
ip_address
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
email — affiliate member’s email address
phone_number — affiliate member’s phone number (optional)
first_name — affiliate member’s first name (optional)
last_name — affiliate member’s last name (optional)
username — affiliate member’s username (optional)
sub_choice — subscription choice (optional, present only if the form included subscription checkbox)
subscribed_at — date affiliate member has subscribed (deprecated; use
opted_in_at
instead)opted_in_at — date affiliate member has subscribed (optional)
phone_opted_in_at — date affiliate member has subscribed with email (optional)
unsubscribed_at — date affiliate member has unsubscribed with phone number (optional)
custom_properties — hash of affiliate member’s custom properties (optional)
is_loyalty_member — whether the affiliate member participates in loyalty program
loyalty_member — details of the affiliate member as a loyalty program participant (optional)
referral_counts — referral counts of affiliate member as Advocate
total — created referrals count
approved — approved referrals count
pending — count of waiting for approval referrals
gender [deprecated]
Sample payload
{
"campaign": {
"cached_slug": 615437538,
"id": 615437538,
"joinable_category_names": ["affiliate_member"],
"new_customer": null,
"origin_max_age": null,
"origin_min_age": null,
"tag_names": ["default"],
"type": "StandaloneCampaign"
},
"custom_properties": {},
"email": "john@example.com",
"first_name": "John",
"gender": null,
"is_loyalty_member": false,
"last_name": "Doe",
"loyalty_member": null,
"offer": {
"email": "referrer@example.com",
"short_url_code": "1a2PV",
"ip_address": "127.0.0.1"
},
"opted_in_at": null,
"phone_number": "+12025551111",
"phone_opted_in_at": null,
"referral_counts": {
"total": 0,
"approved": 0,
"pending": 0
},
"sub_choice": false,
"subscribed_at": null,
"unsubscribed_at": null,
"username": null
}
cURL example
curl <url> \
-d "key=<key>" \
-d "site=<site>" \
-d "type=offer_signup_web_hook" \
-d "extras={}" \
-d 'payload={"campaign":{"cached_slug":615437538,"id":615437538,"joinable_category_names":["affiliate_member"],"new_customer":null,"origin_max_age":null,"origin_min_age":null,"tag_names":["default"],"type":"StandaloneCampaign"},"custom_properties":{},"email":"john@example.com","first_name":"John","gender":null,"is_loyalty_member":false,"last_name":"Doe","loyalty_member":null,"offer":{"email":"referrer@example.com","short_url_code":"1a2PV","ip_address":"127.0.0.1"},"opted_in_at":null,"phone_number":"+12025551111","phone_opted_in_at":null,"referral_counts":{"total":0,"approved":0,"pending":0},"sub_choice":false,"subscribed_at":null,"unsubscribed_at":null,"username":null}'