Zoho Writerにおける受信Webhookのデータソース利用

Zoho Writerにおける受信Webhookのデータソース利用

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

概要

Zoho Writer では、受信 Webhook をデータソースとして利用し、Fillout や Shopify などのサードパーティアプリ、または任意のカスタムアプリからフィールド値を直接受信してドキュメントを生成できます。データを別の場所に保存しておく必要はありません。これにより、Webhook ペイロードを送信できる任意のアプリからリアルタイムでデータを取得し、そのデータを使って即座にドキュメントを差し込み生成できます。

前提条件

  1. 外部アプリ側で Webhook が有効になっていること
  2. サポートされるペイロード形式
    1. JSON
    2. フォームデータ
    3. URL エンコードデータ
      1. ドット記法（例：customer.name）
      2. アンダースコア記法（例：customer_name）
    4. 配列（単一または複数データ）

手順

受信 Webhook をデータソースとして設定する方法

  1. Zoho Writer で差し込みテンプレートを開きます。
  2. ［自動化］ペインの［データソースを選択］で、［＋ データソースを追加］をクリックします。
  3. ［受信 Webhook］を選択します。
  4. ［受信 Webhook からフィールドを取得］ダイアログが開きます。
  5. ［フィールドを取得］（以前に取得済みの場合は［フィールドを更新］）をクリックします。
  6. Webhook ペイロードで受信したすべてのキーが、［外部アプリからのフィールド］の下に一覧表示されます。
  7. 差し込みで使用するフィールドを選択します。
  8. ［インポート］をクリックします。
Notes
メモ
  1. このダイアログを閉じるまで、選択した Webhook URL を使用して受信 Webhook アクションから差し込みを開始することはできません。

  2. Webhook ペイロードで受信したサブフォームフィールドは、サブフォームフィールドとしてではなく、メインフィールド一覧内の通常の差し込みフィールドとしてインポートされます。

ペイロードで差し込みをトリガーする方法

  1. 生成された Webhook URL をコピーします。
  2. 外部アプリケーションの Webhook / API 送信先フィールドに貼り付けます。
  3. 外部アプリで、「使用するペイロードコード」セクションに表示されている形式と同じ形式でフィールド値を送信します。
  4. JSONを選択した場合は、表示されている JSON 構造に従って値を渡します。
  5. フォームデータ / URL エンコードを選択した場合は、表に表示されているのと同じフィールド ID を使用して値を渡します。

  6. Webhook を 1 回トリガーしてサンプルデータを送信します。Zoho Writer がキーを検出し、フィールドインポート用に一覧表示します。
Idea
マッピングの問題を回避するには、今後の Webhook 送信が、ペイロードコードセクションに表示されているペイロード形式と同一になるようにしてください。

新しい Webhook URL を生成する方法

  1. Zoho Writer で差し込みテンプレートを開きます。
  2. ［自動化］ペインの［データソースを選択］で、［＋ データソースを追加］をクリックします。
  3. ［受信 Webhook］を選択します。
  4. ［受信 Webhook からフィールドを取得］ダイアログが開きます。
  5. ［受信 Webhook URL を選択］で、［新しい Webhook URL を生成］を選択します。
  6. 次の詳細を入力します。
    1. Webhook 名（必須）
    2. 説明（任意）
  7. ［作成してコピー］をクリックして、一意の Webhook URL を生成します。

これで、この Webhook URL を、Zoho Writer にフィールド値を送信する外部アプリケーションに貼り付けて使用できます。

Notesメモ
異なるアプリやワークフロー向けに複数の Webhook URL を生成しておき、後からドロップダウンで必要なものを選択して使用することもできます。

既存の Zoho Flow または Zapier ワークフローにドキュメント生成を追加する方法

前提条件

  1. Zoho Writer の差し込みテンプレートの Webhook URL。Webhook URL を生成する手順はこちらを参照してください。

手順

  1. ドキュメント生成を追加したい既存の Zoho Flow または Zapier ワークフローを開きます。
  2. ドキュメント生成を行いたい位置（差し込みデータを提供するカードの直後など）に、Webhookアクションカードを挿入します。
  3. Webhook アクションを設定します。
    1. アクションイベント：POST メソッドを選択します。
    2. Zoho Writer テンプレートの Webhook URL を貼り付け、フローまたは Zap の前のステップから必要なデータフィールドを Webhook のペイロードにマッピングします。ペイロード内のキーが、Writer の差し込みテンプレート内の差し込みフィールド名と完全に一致していることを確認してください。
  4. アクションを保存してテストし、データが正常に送信され、ドキュメントが生成されることを確認します。

FAQ

  1. Webhook ペイロードから自動的に差し込みを開始できますか？
    このフローではできません。Webhook 通話で自動的に差し込みをトリガーする方法については、こちらのページを参照してください。

  2. 特定のフィールドだけをインポートできますか？
    はい。ダイアログで選択したフィールドのみが差し込み設定に追加されます。

  3. 同じ Webhook URL または別の Webhook URL から、後で追加のフィールドをインポートできますか？
    はい。受信 Webhook をデータソースとして選択した後は、いつでも［インポートフィールド］をクリックして追加のフィールドを取得できます。次のいずれかを使用できます。
    1. 同じ Webhook URL
    2. 別の Webhook URL
      インポート時に別の Webhook URL を選択した場合、その URL はフィールドの取得のみに使用され、設定パネルのデータソースとしては表示されません。データソースとして表示されるのは、最初に選択したメインの Webhook のみです。

トラブルシューティング

症状
考えられる原因
推奨される解決策
［フィールドを取得］をクリックしてもフィールドが表示されない
ペイロードが受信されていない
外部アプリケーションからテストイベントをトリガーする
期待していた一部のフィールドが表示されない
ペイロードのキーが入れ子になっている、または名前が変更されている
ペイロードを再送信し、［フィールドを更新］をクリックする
差し込み時にフィールドが空白になる
マッピングが完了していない
［フィールドの管理］セクションを確認し、再度マッピングする
外部アプリで Webhook が拒否される
リクエストタイプが誤っている
アプリが HTTP POST でペイロードを送信していることを確認する
  1. 受信 Webhook を使用して差し込みをトリガーする方法
  2. フィールドタイプ設定で差し込みフィールドの表示方法を制御する
  3. Writer のメールマージにおけるデータソースとその上限の管理