受信Webhook
受信Webhookは、イベントが発生したときに、サードパーティーサービスやAPIリクエ ストから情報をZoho Booksに受け取る方法です。Zoho Booksでは、サードパーティー サービスで行われたアクションをトリガーとして使用し、Zoho Books内でタスクを実 行することが可能です。以下に、この概念をより具体的に説明するいくつかのシナリオ を示します。
シナリオ: Zylkerは生地を製造する会社です。注文が入ると、セールスチームは注文の詳細をプロ ダクションチームのグループと共有します。そのメッセージには完了ボタンがあり、 バッチが生産されたときにプロダクションマネージャーがクリックできます。ボタンを クリックすると、受信Webhookがトリガーされ、Zoho Booksに自動的に請求書が作成 されます。
シナリオ: マーケティングマネージャーのパトリシアは、イベントでZylkerの製品を紹 介しています。パトリシアは、イベント中に自身のブースを訪れる見込み顧客のメール アドレスを収集します。その後、顧客が詳細を追加して目的の製品を購入できるフォー ムをメールで送信します。顧客がフォームに詳細を入力し、送信ボタンをクリックする と、受信Webhookがトリガーされ、顧客の詳細がZoho Booksに追加されます。
受信Webhookの作成
Zoho Booksで実行したい機能に基づいて、複数の受信Webhookを作成できます。
受信Webhookを作成するには：
- ページの右上隅にある［設定］に移動してください。
- ［開発者向け情報］の下の
- ［受信Webhook］を選択してください。
- ページの右上隅にある［+ 新しい受信Webhook］をクリックします。
- 受信Webhookの［名前］と［詳細］を入力します。
- 下のエディターにDelugeを使用して関数を入力します。
- ［保存］をクリックします。
OAuth URLとZAPI Key URLが生成され、ポップアップに表示されます。ポップアップからURLをコピーできます。
リストページの受信Webhook名の横にある下向き矢印をクリックして、URLをコピーすることもできます。
ヒント: Webhook URLを再生成する場合、古いURLを使用している場所すべてで新し いURLに置き換える必要があります。受信Webhookの編集ページにある［再生成］ボ タンをクリックすると、URLが再生成されます。
メモ: 権限のあるユーザーだけがURLにアクセスできるようにしてください。公開されている場合、URLにアクセスできるユーザーは誰でもデータにアクセスできます。
これで、サードパーティーアプリケーションのURLを構成し、受信Webhookを設定することができます。スクリプトに属性を追加したい場合は、APIコール時に追加できます。
| 属性 | 説明 |
|---|---|
| ヘッダー | APIリクエストのヘッダー。 |
| パラメーター | パラメーターは、サードパーティーのAPIリクエストによって提供されるスクリプトの可変部分です。 |
| ボディ | APIコールのリクエストデータを含む文字列です。 |
上記の属性を設定すると、受信webhookが作成されます。
これで、サードパーティーアプリケーションでアクティビティが発生すると、受信Webhookがトリガーされ、関数に記載されているアクションが実行されます。
ログの表示
Zoho Booksで実行されたすべての受信Webhookのリストは、受信Webhookの編集ページの「ログを表示する」セクションで確認できます。
受信Webhookの編集と削除
Zoho Booksで作成した受信Webhookを編集または削除できます。方法は以下の通りです。
- ページの右上隅にある［設定］に移動してください。
- ［開発者向け情報］の下の［受信Webhook］を選択してください。
- 編集または削除したい受信Webhookの横にあるドロップダウンをクリックします。
- 「編集］または［削除］をクリックしてください。
