概要
Webhookの概要
Webhookとは、イベントが発生した時点で、あるアプリから別のアプリへリアルタイムの情報を送信する仕組みです。アプリ間の通知システムのようなものと考えてください。更新を確認する代わりに、何かが発生するとWebhookが選択したシステムに自動的に通知します。
Zoho ThriveにおけるWebhookの仕組み
1. 管理者は、次の内容を入力してThriveでWebhookを設定します。
Webhookの名前
Webhookをトリガーするイベント
外部システムのURL(データの送信先)
必要に応じて任意のヘッダー値
2. 選択したイベント(たとえば、特典の引き換えやティアのアップグレード)が発生すると、Thriveは関連するイベントデータを含むPOST要求を指定されたURLに送信します。
Webhookの設定
新しいWebhookを追加するには、次の手順を実行します。
1. 右上隅の[設定]アイコン→[開発者設定]→[Webhook]に移動します。
2. [+ Webhookを追加]をクリックします。
3. 必要な詳細を入力します。
[名前]:Webhookの名前を入力します。
[定義済みのイベント]:Webhookをトリガーするイベントを1件以上選択します。
[Webhook URL]:Thriveがデータを送信する有効なURLを入力します。
[ヘッダー](任意):エンドポイントで必要な場合は、キーと値のペアを追加します(認証やカスタムパラメーター用)。
4. すべての詳細を入力したら、次の操作を行えます。
[APIのテスト]をクリックして、Webhook URLがデータを正しく受信しているか確認します。
[追加]をクリックしてWebhookを保存します。
利用可能なロイヤルティイベント。
Facebookで共有
Xで共有
購入
メンバーになる
紹介による購入
友達を紹介
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@ジルカー.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@ジルカー.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@ジルカー.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@ジルカー.com',
'reward_name': 'Custom Reward',
'total_points': 3340,
'redeemed_points': 100,
'user_program_id': 2000000859031,
'contact_id': 2000000859027,
'event': 'redeem_rewards'
}
}
{
'code': 200,
'message': {
'email_id': 'sherin@ジルカー.com',
'points_details': 100,
'earned_points': 470,
'contact_id': 826000000297001,
'user_program_id': 826000000297005,
'event': 'follow_instagram'
}
}
{
'code': 200,
'message': {
'email_id': 'enzo@ジルカー.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@ジルカー.com',
'points_details': 45,
'earned_points': 55,
'contact_id': 2000000870001,
'user_program_id': 2000000870005,
'event': 'testimonial_activity',
'review_details': 'The product is so good'
}
}
{
'code': 200,
'message': {
'email_id': 'dustin@ジルカー.com',
'points_details': 12,
'earned_points': 75,
'unique_identifier': 'customreward',
'contact_id': 2000000858001,
'user_program_id': 2000000858005,
'event': 'custom_activity_tracker'
}
}