Webhookの作成

Webhookの作成

Webhookは、Web上で外部のアプリやWebサイトから、リアルタイムのデータや情報を取得できる機能です。この機能はシンプルで、導入も簡単です。情報が必要なWebサイトは、現在使用しているアプリに設定されているURLに関連付けらます。これらのWebサイトが新しい情報で更新されると、アプリケーションで設定したURLで、通知を受信します。あとは、情報が届くのを待つだけです。

利用可能なプラン

Zoho CampaignsのWebhookを利用するメリット

Zoho CampaignsでWebhookを利用できるようになりました。Webhookを使用して、配信したキャンペーンとリストに含まれる連絡先の情報を収集できます。Zoho Campaignsでは、次の2種類のWebhookを利用できます：

  • 連絡先のWebhook： 配信リストに含まれる連絡先の登録、登録解除、バウンス（不達）などの活動を把握できます。
  • キャンペーンのWebhook： キャンペーン作成から受信者への配信までの間の、キャンペーンのステータスを把握できます。

次の例を見てみましょう：スティーブは、重要なキャンペーンを特定の連絡先リストに配信して、そのキャンペーン結果を分析する必要があります。スティーブは、データを生成するために、次の3つのタスクを実施しなければなりません：

  • キャンペーンの進捗を把握して、確実にキャンペーンの配信を完了する
  • リストに含まれるすべての連絡先に対して、確実にキャンペーンを配信する
  • リストから削除した連絡先や、新しくリストに追加した連絡先があれば特定する

これらは、手動で実施した場合には時間がかかるタスクばかりです。Webhookは手動タスクを自動化し、上記の処理が発生した場合に、定期的な更新情報を配信します。つまり、スティーブは、必要なデータを収集して更新情報を通知するURLを、自分のアプリケーションに設定すればいいだけです。

URLの生成

Webhook設定の最初の手順は、リクエストの配信先となるURLを指定することです。このURLは、目的のWebサイトにデータを入力するために使用できます。これは通常、バックエンドまたはAPIを通じて実行されます。データを入力したいアプリケーションからURLを取得し、Zoho CampaignsのWebhookに貼り付けることができます。

Webhookの作成

Webhook利用のメリットについて確認できましたので、次は、Zoho CampaignsアカウントでWebhookを設定する手順について確認しましょう。手順は次のとおりです：

1.画面右上の設定アイコンをクリックします。



2.［開発者向け情報］→［Webhook］の順に移動します。

    設定
3.こちらでは、連絡先またはキャンペーンのWebhookを作成できます。 



4.いずれかの種類のWebhookの欄で［作成する］をクリックして、以下の詳細を入力します。
  1. Webhookの名前
  2. データの送信先のサービス／アプリで設定するWebhookのURL 
  3. 1時間あたりの実行回数（無料プランの初期設定の実行回数：60回） 
  4. リクエスト（データ抽出）のメソッド（POSTまたはGET）
  5. 連絡先のWebhookの場合、［URLのパラメーター］のセクションでパラメーターの名前、種類、値を指定します。


5.［保存する］をクリックします。
       
Webhookをさらに作成するには、以下の手順を実行します。 
  1. 画面左側のメニューから［連絡先］を選択します。
  2. ［リスト管理］を選択し、Webhookを関連付けるリストを選択します。
  3. ［…］（その他の操作）ボタンをクリックして、［Webhook］を選択します。



  4. 必要に応じて、連絡先またはキャンペーンのWebhookの欄で［関連付ける］をクリックします。
  5. Webhookの関連付けのページで、Webhookの選択のドロップダウンから［Webhookを追加する］をクリックします。
  6. Webhookの作成画面で、以下の詳細を入力します。
    1. Webhookの名前
    2. データの送信先のサービス／アプリで設定するWebhookのURL
    3. リクエスト（データ抽出）のメソッド（POSTまたはGET）
    4. 1時間あたりの実行回数（無料プランの初期設定の実行回数：60回）
     7.連絡先のWebhookの場合、［処理］の項目でWebhookの対象となる処理を選択します。［登録］、［登録解除］、［不達］の中から選択可能です。
     8.連絡先のWebhookの場合、［処理実行者］の項目で［管理者／ユーザー］または［連絡先］のいずれかを選択します。［処理］、［処理実行者］の選択内容に基づいて、Webhookが実行されます。
     9.連絡先のWebhookの場合、［URLのパラメーター］のセクションでパラメーターの名前、種類、値を指定します。     
                    

     10.キャンペーンのWebhookの場合、［処理］の項目で次のいずれかの内容を選択します：レビュー中、レビュー済み、A/Bテストの完了、A/Bテストの勝者（成果の高いメール）、A/Bテストが不確定、停止、キャンセル済み、一時停止、再開済み、配信済み
      11.詳細の入力完了後、［作成する］をクリックします。

Webhookの関連付け

Webhookとリストを関連付けることで、連絡先やキャンペーンのリストから情報を収集することができます。また、複数のWebhookを関連付けることで、さまざまな情報を収集することも可能です。 

連絡先やキャンペーンのWebhookを関連付けるには、以下の手順を実行します。

     
  1. 画面左側のメニューから［連絡先］を選択します。



  2. ［リスト管理］を選択し、Webhookを関連付けるリストを選択します。



  3. ［…］（その他の操作）ボタンをクリックして、［Webhook］を選択します。



  4. ［関連付ける］をクリックします。



  5. Webhookの関連付けの画面で、以下の操作を実行します。


    1. 別のリストの既存のWebhookを選択するか、新しいWebhookを追加します。
    2. 通知対象の処理を選択します。



    3. 処理の実行者を選択します。
       6.［保存する］をクリックします。

複数の連絡先やキャンペーンのWebhookを関連付けることも可能です。関連付けるには、以下の手順を実行します。 
  1. 画面左側のメニューから［連絡先］を選択します。
  2. ［リスト管理］を選択し、Webhookを関連付けるリストを選択します。
  3. ［…］（その他の操作）ボタンをクリックして、［Webhook］を選択します。
  4. 対象のWebhookの欄で［関連付ける］をクリックし、連絡先やキャンペーンのWebhookをさらに関連付けます。



  5. Webhookの関連付けの画面で、以下の操作を実行します。
    1. 別のリストの既存のWebhookを選択するか、新しいWebhookを追加します。
    2. 通知対象の処理を選択します。
    3. 処理の実行者を選択します。


       6.［保存する］をクリックします。

Webhookの関連付けの解除 

Webhookとリストの関連付けを解除できます。関連付けを解除しても、該当のWebhookはWebhookの一覧ページに引き続き表示されます。Webhookとリストの関連付けを解除するには、以下の手順を実行します。


  1. 画面左側のメニューから［連絡先］を選択します。
  2. ［リスト管理］を選択し、Webhookとの関連付けを解除するリストを選択します。
  3. ［…］（その他の操作）ボタンをクリックして、［Webhook］を選択します。
  4. リストとの関連付けを解除するWebhookにカーソルを合わせて、関連付けの解除のアイコンをクリックします。



以下の手順で関連付けを解除することもできます。
  1. 画面左側のメニューから［連絡先］を選択します。



  2. ［リスト管理］を選択し、Webhookとの関連付けを解除するリストを選択します。
  3. ［…］（その他の操作）ボタンをクリックして、［Webhook］を選択します。
  4. リストとの関連付けを解除するWebhookにカーソルを合わせて、レポートのアイコンをクリックします。
  5. 画面右上の詳細の表示のアイコンをクリックして、関連付けの解除のアイコンをクリックします。
  6. 確認画面で操作を確定します。


Webhookの削除 

必要に応じて、設定画面でWebhookを削除できます。削除するには、以下の手順を実行します。


  1. 画面右上の設定アイコンをクリックします。 
  2. ［開発者向け情報］→［Webhook］の順に移動します。
  3. 対象のWebhookを選択します。
  4. Webhookの詳細ページの右上にある削除アイコンをクリックします。確認画面で操作を確定します。Webhookの削除後、元に戻すことはできません。

    Webhookの削除

レポートの表示

このセクションには、Webhookに関する情報が表示されます。すべてのWebhookを確認したり、フィルターを適用して特定のWebhookのみを抽出したりすることもできます。レポートを表示するには、以下の手順を実行します。
  1. 画面左側のメニューから［連絡先］を選択します。
  2. ［リスト管理］を選択し、Webhookのレポートを表示するリストをクリックします。
  3. ［…］（その他の操作）ボタンをクリックして、［Webhook］を選択します。



  4. 対象のWebhookにカーソルを合わせて、レポートアイコンをクリックします。
以下の手順でレポートを表示することもできます。
  1. 画面右上の設定アイコンをクリックします。
  2. ［開発者向け情報］→［Webhook］の順に移動します。
  3. 詳細を表示するWebhookを選択します。



  4. Webhookの詳細ページの右上にあるレポートアイコンをクリックします。

Webhookの詳細の表示 

Webhookの詳細ページでは、Webhookの設定などの各種詳細が表示されます。こちらでは、Webhookの設定の編集、レポートの表示、Webhookの関連付けの解除などの操作を行うことができます。Webhookの詳細ページを表示するには、以下の手順を実行します。
  1. 画面左側のメニューから［連絡先］を選択します。
  2. ［リスト管理］を選択し、Webhookのレポートを表示するリストをクリックします。
  3. ［…］（その他の操作）ボタンをクリックして、［Webhook］を選択します。



  4. 対象のWebhookにカーソルを合わせて、レポートアイコンをクリックします。
  5. Webhookのレポートのページの右上にある詳細の表示のアイコンをクリックします。
以下の手順でレポートを表示することもできます。 
  1. 画面右上の設定アイコンをクリックします。
  2. ［開発者向け情報］→［Webhook］の順に移動します。
  3. 詳細を表示するWebhookを選択します。Webhookの詳細ページが表示されます。