Webhooks in Zoho Thrive
Overview
What is a webhook?
A webhook is a way for one app to send real-time information to another app as soon as an event happens. Think of it like a notification system between apps, instead of you checking for updates, the webhook automatically “pings” your chosen system when something occurs.
How webhooks work in Zoho Thrive
1. The admin sets up a webhook in Thrive by entering:
-
A name for the webhook
-
The events that should trigger it
-
The external system’s URL (where data will be sent)
-
Optional header values, if required
2. When the selected event happens, for example, a reward redemption or tier upgrade, Thrive sends a POST request to the specified URL with relevant event data.
Setting up a webhook
To add a new webhook:
1. Navigate to the Settings icon on the top-right corner -> Developer Settings -> Webhooks.
2. Click + Add Webhook.
3. Fill out the required details.
-
Name: Enter a name for the webhook.
-
Predefined events: Select at least one event that will trigger the webhook.
-
Webhook URL: Enter a valid URL where Thrive will send data.
-
Headers (optional): Add key-value pairs if your endpoint requires them (for authentication or custom parameters).
4. Once you’ve filled all the details, you can:
-
Click Test API to check if your webhook URL is receiving data correctly.
-
Click Add to save your webhook.
Available loyalty events:
-
Share on Facebook
-
Share on X
-
Make a Purchase
-
Become a Member
-
Referral Purchase
-
Refer a Friend
-
Zoho Survey
-
Like us on Facebook
-
Follow us on Instagram
-
Follow us on LinkedIn
-
Follow us on X
-
Subscribe to us on YouTube
-
Purchase Value Goal
-
Purchase Count Goal
-
Custom Task
-
Review on GetApp
-
Review on Capterra
-
Review on Product Hunt
-
Review on Trustpilot
-
Customer Testimonial
-
Review on Google
-
Manual Point Adjustment
-
Reward Redemption
-
Tier Upgrade
-
Manual Referral Addition
-
Manual Opt-in
The Webhooks tab lists all the webhooks you’ve created along with their details:
Status: Toggle to enable or disable a webhook.
Name: The webhook name you’ve set.
Webhook URL: The destination endpoint.
Events: Number of events configured for that webhook.
Example use case
Let’s say you’ve created a webhook for the Tier Upgrade event.
When a customer moves from Silver to Gold tier:
-
Thrive automatically sends a POST request to your given URL.
-
Your system receives the data and can trigger an action, such as sending a personalized "Congrats" email or adding extra rewards.
This below example response shows how data is sent to the connected system once the Tier Upgrade event is triggered and completed. It helps to understand the data flow between Zoho Thrive and external systems.
{
code: 200
message: {
email_id : michael@zylker.com
previous_tier : silver
current_tier : gold
total_points : 100
user_program_id : 826000000272057
contact_id : 826000000272053
event : tier_upgrade
}
}
|
Events
|
Responses
|
|
Manual program opt in and customer referral addition
|
{ "code": 200, "message": { "email_id": "nikil@zylker.com", "user_type": "customer", "joined_date": 1759218470551, "is_loyalty_optin": true, "last_name": "value", "contact_id": 5534000000070003, "user_program_id": 5534000000070007, "event": "opt_in", "first_name": "nikil" } }
|
|
Make a Purchase
|
{ "code": 200, "message": { "email_id": "john@zylker.com", "amount": 2345, "contact_id": 826000000360171, "user_program_id": 826000000360175, "purchase_time": 1759730191692, "event": "new_purchase", "order_id": "sdfvegbr", "purchase_order_track_id": 826000000360225 } }
|
|
Reward Redemption
|
{ "code": 200, "message": { "email_id": "jacob@zylker.com", "reward_name": "Custom Reward", "total_points": 3340, "redeemed_points": 100, "user_program_id": 2000000859031, "contact_id": 2000000859027, "event": "redeem_rewards" } }
|
|
Social events actions such as Share on Facebook, Share on X, Like us on Facebook, Follow us on Instagram, Follow us on LinkedIn, Follow us on X, and Subscribe to us on YouTube. Other events include Refer a Friend, Referral Purchase, Purchase Value Goal, and Purchase Count Goal.
|
{ "code": 200, "message": { "email_id": "sherin@zylker.com", "points_details": 100, "earned_points": 470, "contact_id": 826000000297001, "user_program_id": 826000000297005, "event": "follow_instagram" } } |
|
Review events such as Review on GetApp, Capterra, Product Hunt, Trustpilot, and Google.
|
{ "code": 200, "message": { "email_id": "enzo@zylker.com", "points_details": 10, "earned_points": 110, "contact_id": 826000000348001, "user_program_id": 826000000348005, "event": "google_review_activity", "review_details": "https://ennie.com" } } |
|
Customer testimonial
|
{ "code": 200, "message": { "email_id": "bonnie@zylker.com", "points_details": 45, "earned_points": 55, "contact_id": 2000000870001, "user_program_id": 2000000870005, "event": "testimonial_activity", "review_details": "The product is so good" } } |
|
Custom Task
|
{ "code": 200, "message": { "email_id": "dustin@zylker.com", "points_details": 12, "earned_points": 75, "unique_identifier": "customreward", "contact_id": 2000000858001, "user_program_id": 2000000858005, "event": "custom_activity_tracker" } }
|