Zoho ThriveのWebhook
概要
Webhookとは
Webhookは、イベントの発生と同時に、あるアプリから別のアプリへリアルタイムで情報を送信する仕組みです。アプリ間の通知システムのようなものです。更新を手動で確認しなくても、何らかのイベントが発生すると、Webhookによって指定したシステムに自動で通知されます。
Zoho ThriveにおけるWebhookの仕組み
1. 管理者は、次の情報を入力してThriveでWebhookを設定します。
-
Webhookの名前
-
Webhookをトリガーするイベント
-
外部システムのURL（データの送信先）
-
必要に応じて、任意のヘッダー値
2. 特典交換やレベルのアップグレードなど、選択したイベントが発生すると、Thriveから指定したURLに関連するイベントデータを含むPOSTリクエストが送信されます。
Webhookの設定
新しいWebhookを追加するには、以下の手順を実行します。
1. 画面右上の［設定］アイコンから、［開発者設定］→［Webhook］の順に移動します。
2. ［+ Webhookを追加する］をクリックします。
3. 必須の詳細情報を入力します。
-
［名前］：Webhookの名前を入力してください。
-
［定義済みのイベント］：Webhookをトリガーするイベントを1件以上選択します。
-
［WebhookのURL］：Thriveからデータを送信する有効なURLを入力してください。
-
［ヘッダー（任意）］：エンドポイントで必要な場合は、認証情報や個別指定のパラメーターなどのキーと値の組み合わせを追加します。
4. 詳細をすべて入力したら、次の操作を行えます。
-
WebhookのURLでデータを正しく受信できるか確認するには、［APIをテスト］をクリックします。
-
Webhookを保存するには、［追加する］をクリックします。
利用可能なロイヤルティイベント。
-
Facebookで共有する
-
X（旧Twitter）で共有する
-
購入
-
メンバー登録
-
被紹介者による購入
-
他の人に紹介
-
Zoho Survey
-
Facebookで「いいね！」する
-
Instagramでフォロー
-
LinkedInでフォロー
-
Xでフォロー
-
YouTubeチャンネルに登録
-
購入金額の目標
-
購入件数の目標
-
カスタムタスク
-
GetAppでの口コミ
-
Capterraでの口コミ
-
Product Huntでのレビュー
-
Trustpilotでの口コミ
-
お客さまの声
-
Googleでのレビュー
-
ポイントの調整（手動）
-
特典交換
-
レベルのアップグレード
-
被紹介者の追加（手動）
-
手動オプトイン
［Webhook］タブには、作成済みのすべてのWebhookとその詳細が表示されます。
［ステータス］：切り替えスイッチを使用してWebhookを有効または無効にします。
［名前］：設定したWebhookの名前です。
［WebhookのURL］：送信先のエンドポイントです。
［イベント］：対象のWebhookに設定されているイベントの件数です。
使用例
たとえば、レベルのアップグレードイベント用のWebhookを作成したとします。
顧客のレベルがシルバーからゴールドに上がると、次の処理が実行されます。
-
Thriveから指定したURLにPOST要求が自動送信されます。
-
システムはデータを受信し、個別のお祝いメールの送信や特典の追加などの処理を実行できます。
以下の応答例は、レベルのアップグレード イベントの実行が完了した後、連携中のシステムにデータが送信される仕組みを示しています。Zoho Thriveと外部システム間のデータフローを把握するのに役立ちます。
{
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
}
}
|
イベント |
応答 |
|
プログラムへの手動登録と顧客の紹介の追加 |
{ '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' } }
|
|
購入
|
{ '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 } }
|
|
特典交換
|
{ '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' } }
|
|
Facebookで共有する、Xで共有する、Facebookで「いいね！」、Instagramでフォロー、LinkedInでフォロー、Xでフォロー、YouTubeでチャンネル登録などのソーシャルイベントのアクション。その他のイベントには、他の人に紹介、被紹介者による購入、購入金額の目標、購入件数の目標があります。
|
{ 'code': 200, 'message': { 'email_id': 'sherin@zylker.com', 'points_details': 100, 'earned_points': 470, 'contact_id': 826000000297001, 'user_program_id': 826000000297005, 'event': 'follow_instagram' } } |
|
GetApp、Capterra、Product Hunt、Trustpilot、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' } } |
|
顧客の声 |
{ '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': '商品はとても良いです' } } |
|
カスタムタスク |
{ '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' } }
|