Friend Email Gating Web Hook

Triggered when Friend Email Gating form is submitted (on Friend Claim Page).

Payload parameters provided

  • offer — subhash of parameters describing the offer
    • email — referrer’s email address
    • short_url_code
  • campaign — subhash of parameters describing the campaign
    • id — unique campaign ID
    • cached_slug — unique SEO friendly ID
    • type — either “StandaloneCampaign” or “DoubleSidedDealCampaign”
    • tag_names — array of campaign’s tags
  • email — friend’s email address
  • first_name — friend’s first name
  • last_name — friend’s last name
  • sub_choice — subscription choice (optional, present only if the form included subscription checkbox)
  • subscribed_at — date friend has subscribed (optional)
  • unsubscribed_at — date friend has unsubscribed (optional)

Sample payload

{
  "offer": {
    "email": "referrer@example.com",
    "short_url_code": "1a2PV"
  },
  "campaign": {
    "id": 350256053,
    "type": "StandaloneCampaign",
    "cached_slug": "affiliate-campaign-test",
    "tag_names": ["default"]
  },
  "email": "john@example.com",
  "first_name": null,
  "last_name": null,
  "sub_choice": true,
  "subscribed_at": "2014-08-13T11:14:08.835-07:00",
  "unsubscribed_at": null
}

cURL example

curl --data 'key=<key>&payload={"offer":{"email":"referrer@example.com","short_url_code":"1a2PV"},"campaign":{"id":350256053,"type":"StandaloneCampaign","cached_slug":"affiliate-campaign-test","tag_names":["default"]},"email":"john@example.com","first_name":null,"last_name":null,"sub_choice":true,"subscribed_at":"2014-08-13T11:14:08.835-07:00","unsubscribed_at":null}' <url>