enter the URL of your webhook and choose which events you want to receive
Update/delete a webhook
To update or delete a webhook hover over the three dots to the right of the webhook to open the settings menu and click on the link to update or delete.
Test a webhook
To test a webhook hover over the three dots to the right of the webhook to open the settings menu and click on "Send test webhook"
Authentication token
SparkLoop authenticates all webhooks with a token in the SparkLoop-Token request header. This allows you to verify that the events were sent by SparkLoop, not by a third party.
While this is entirely optional, it adds an extra layer of security: simply check the token in the SparkLoop-Token header is the same as your authentication token. If not, ignore the webhook!
Is sent when a subscriber hits a milestone and unlocks a reward
{"type":"reward_unlocked","campaign_id":"MF6319db9890","referrals":4,"coupon_code":"9wusha0","subscriber": {"id":"sub_hjdgc74u","first_name":"John","name":"John Doe ","email":"john.doe@email.com","referral_code":"f9464199","referral_link":"https://mywebsite.com?rh_ref=f9464199","referred":true,"tot_referrals":4,"next_reward":2,"created_at":1564403873 },"reward": {"id":"reward_cdebf4f013","name":"2018 Private Report: State of the Ecommerce","referrals":4,"recurring":false }}
reward_redeemed
Is sent when a subscriber redeems a reward by submitting their address details.
{"type":"reward_redeemed","campaign_id":"MF6319db9890","referrals":4,"coupon_code":"9wusha0","subscriber": {"id":"sub_hjdgc74u","first_name":"John","name":"John Doe ","email":"john.doe@email.com","referral_code":"f9464199","referral_link":"https://mywebsite.com?rh_ref=f9464199","referred":true,"tot_referrals":4,"next_reward":2,"created_at":1564403873 },"reward": {"id":"reward_cdebf4f013","name":"2018 Private Report: State of the Ecommerce","referrals":4,"recurring":false },"reward_variant_name":"T-Shirt XXL","reward_variant_sku":"t_shirt_xxl","shipping_details": {"shipping_name":"John Doe","shipping_phone":"+01 407-889-2040","shipping_address_1":"7838 Pearl Drive","shipping_address_2":null,"shipping_city":"Sun City","shipping_state_code":"AZ","shipping_zipcode":"85351","shipping_country_code":"US" }}
sync_subscriber
Is sent when a referral is created or updated.
{"type":"sync_subscriber","subscriber": {"id":"sub_hjdgc74u","first_name":"John","name":"John Doe ","email":"john.doe@email.com","referral_code":"f9464199","referral_link":"https://mywebsite.com?rh_ref=f9464199","referred":true,"tot_referrals":4,"referral_status":"rejected","next_reward":2,"created_at":1564403873 }}
Errors
Please send back a blank response with a status code of 200.
All not-200 responses will be considered errors.
