送信ウェブフック

送信ウェブフック

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


Webhook トリガーは、アプリケーションから受信したデータ更新を基にフローを開始できますが、送信 Webhookは、外部アプリケーションやサービスに HTTP リクエストを送信できるようにします。
送信 Webhook を使用すると、カスタム接続を使って HTTP リクエスト経由で任意の API にアクセスできます。これらの外部連携はトークンの更新ロジックを自動的に処理するため、アプリケーションとの連携が容易になります。これらの外部連携は、組み込み接続と同様に使用でき、送信 Webhook とカスタム関数の両方を使ってアプリケーションと連携できます。
送信 Webhook は、次のようなシナリオで使用できます。
  1. 外部アプリケーションや未対応処理との連携: ワークフローが Zoho Flow でまだ利用できないアプリケーションや特定の処理に依存している場合、送信 Webhook を使用してそのアプリケーションの API にアクセスし、カスタム接続を作成して、フローにシームレスに連携できます。
  2. オンプレミスアプリの連携: オンプレミスアプリとの連携が必要な場合、送信 Webhook によってそれらとの連携をサポートできます。
  3. リアルタイムのデータ更新: 特定のトリガーやイベントが発生したときに、指定した URL へデータを即時に送信するリアルタイム更新にも対応しています。

重要な用語

ヘッダー

認可や識別などの目的で、HTTP リクエストと一緒に送信される追加情報です。

アクセストークン
リソース（API）へ初めてアクセスする際に使用される認証情報です。付与されたアクセストークンの有効期限が切れるたびに、新しいアクセストークンを作成する必要があります。 

リフレッシュトークン
リフレッシュトークンは、既存のアクセストークンの有効期限が切れたときに、新しいアクセストークンを取得するために使用される特別なトークンです。

更新ロジック
現在のアクセストークンの有効期限が切れたときに、リフレッシュトークンを使用して新しいアクセストークンを取得するプロセスです。このプロセスは、リソース（API）への安全なアクセスを維持するうえで重要であり、ユーザーが手動で再認証する必要をなくします。

Auth プロファイル
Auth プロファイルは、認証情報を保存することで外部アプリケーションやサービスに接続できるようにします。送信 Webhook 用の外部連携を作成する際に使用します。

API メソッド 

GET - サーバーからデータを取得します（読み取り）。

PUT - サーバー上の既存データを置き換えます（更新）。

POST - サーバーに新しいデータを送信します（作成）。

PATCH - 既存データの一部を更新します（変更）。

DELETE - サーバーからデータを削除します（削除）。

フローで送信 Webhook アクションを使用する方法 

送信 Webhook アクションをフロー内で設定することで、任意の API にアクセスできます。これには、Auth プロファイルの作成とカスタム接続の作成という 2 つの手順が含まれます。ただし、認証が不要なアプリケーションや、ヘッダー経由で認証情報を送信するアプリケーションについては、より簡単なオプションであるNoAuthを使用して設定できます。

 

認証が必要なアプリケーションの場合、送信Webhook では次の 4 種類の認証方式を利用できます。
  1. 基本認証:この方式では、Base64 でエンコードされたユーザー名とパスワードのみを使用してアプリケーションにアクセスします。
  2. OAuth v1.0a:この方式では、ユーザーの認証情報を公開することなく、トークンベースのアクセスでサードパーティアプリケーションを認証します。
  3. OAuth v2:この方式では、アクセストークンとリフレッシュトークンを使用して、ユーザーの認証情報を共有することなく、安全なトークンベースのアプリケーションアクセスを提供します。
  4. API キー:この方式では、アプリケーションから提供される一意のキーを使用して、アプリケーションへの認証およびアクセス許可を行います。

手順 1: Auth プロファイルを作成する 

Auth プロファイルは、認証情報を保存することで外部アプリケーションに接続できるようにします。送信 Webhookアクションをフローで使用するには、対象の外部アプリケーション用に Auth プロファイルを作成する必要があります。Auth プロファイルの作成は 1 回限りの作業であり、同じプロファイルを複数の外部連携で再利用して、アプリケーションに送信 Webhook を実行できます。

メモ: 

  • Auth プロファイルを削除する場合は、先にそのプロファイルを使用している外部連携を削除する必要があります。

  • Auth プロファイルでは、使用中の外部連携がある可能性があるため、認証方式やオンプレミスエージェントを変更することはできません。

手順 2: カスタム接続を作成する 

Auth プロファイルを作成したら、そのプロファイルを複数の外部連携で再利用して、アプリケーションに送信 Webhook を実行できます。各接続は、対応する Auth プロファイルに保存されている認証情報を使用します。

メモ:
  1. アプリケーションとのカスタム接続を作成すると、すべての外部連携が［設定］>［外部連携］に、Auth 権限のラベル付きで一覧表示されます。



  2. 接続の名前は、編集アイコンをクリックすることでいつでも変更できます。接続をテストするには、テストボタンをクリックします。不要になった場合は、ごみ箱アイコンを使用して接続を削除できます。
  3. 接続を削除すると、その接続は完全に削除されます。接続を削除した場合、その接続を使用しているフローは失敗します。接続を使用してフローでこれまでに実行された処理には影響しません。
  4. カスタムアプリの作成時にテスト URL を設定せずに、外部連携ページから接続をテストすると、エラーメッセージが表示される場合があります。
基本 Auth
OAuth v1。0a
OAuth v2
APIキー
基本 Auth
Auth 権限を作成するための手順ガイドは次のとおりです。
  1. ［設定 > Auth 権限］に移動し、［作成］をクリックします。
  2. 認証方法として基本 Authを選択します。
  3. ［Auth 権限名］を入力します。
  4. オンプレミスにインストールされているアプリケーションに接続する必要がある場合は、This app is installed オン-premises チェックボックスをオンにします。
    オンプレミスエージェントの設定と管理方法
  5. 接続が期待どおりに動作するかを確認するためにテスト用の API コールを行う必要がある場合は、［テスト URL を有効にする］チェックボックスをオンにします。URL を入力してテスト URL を設定し、必要に応じてパラメーターとヘッダーの値を指定します。
  6. ［保存］をクリックします。

カスタム接続を作成するための手順ガイドは次のとおりです。
  1. ［設定 > 外部連携］に移動し、［接続を作成］をクリックします。



  2. 表示される設定ウィンドウで、接続を作成するアプリを選択し、［Auth 権限］でそのアプリを選択して、［次へ］をクリックします。
  3. ［接続名］［ユーザー名］［パスワード］を入力します。
  4. ［認証］をクリックします。
OAuth v1。0a
以下は、認証情報を作成するための手順ガイドです。
  1. [設定 > Auth 権限] に移動し、作成をクリックします。
  2. 認証方式としてOAuth v1。0aを選択します。
  3. 次の項目を入力します： Auth 権限 名前、Request Token URL、Authorization URL、およびAccess Token URL。
  4. オンプレミスにインストールされたアプリケーションへ接続する必要がある場合は、[This app is installed オン-premises] チェックボックスをオンにします。
  5. アプリケーションの API ドキュメントで指定されているとおりに OAuth 署名をエンコードする必要がある場合は、Encode OAuth 署名チェックボックス をオンにします。
  6. テスト用の API コールを実行し、接続が期待どおりに動作するか認証したい場合は、有効にする テスト URLチェックボックス をオンにします。テスト URL を設定するには、URL を入力し、必要に応じて Params とヘッダーの値を指定します。
  7. [保存] をクリックします。
以下は、カスタム接続を作成するための手順ガイドです。
  1. [設定 > 外部連携] に移動し、作成 Connectionをクリックします。
  2. 表示される設定ウィンドウで、接続を作成するアプリを選択し、それをAuth 権限の下で選択して、次をクリックします。
  3. 接続を作成するためのConnection 名前を入力します。
  4. 一部のアプリでは、この接続をすべての権限（読み取り、書き込みなど）に適用するか、特定の権限のみに適用するかを選択できます。
  5. [認証] をクリックします。
OAuth v2
OAuth 認証を作成するための手順ガイドは次のとおりです。
  1. ［設定 > Auth 権限］に移動し、［作成］をクリックします。
  2. 認証方式としてOAuth v2を選択します。
  3. ［Auth 権限 名前］と［Authorization URL］を入力します。
  4. オンプレミスにインストールされたアプリケーションに接続する必要がある場合は、［This app is installed オン-premises］チェックボックスをオンにします 。
  5. テスト用の API 呼び出しを行い、接続が想定どおりに動作するか検証する必要がある場合は、［有効にする テスト URL］チェックボックスをオンにします 。［テスト URL］に URL を入力し、必要に応じて Params とヘッダーの値を指定してテスト URL を設定します。
  6. ［保存］をクリックします。
カスタム接続を作成するための手順ガイドは次のとおりです。
  1. ［設定 > 外部連携］に移動し、［作成 Connection］をクリックします。
  2. 表示される設定ウィンドウで、接続を作成するアプリを選択し、Auth 権限の下でそのアプリを選択して、［次］をクリックします。
  3. 接続を作成するためのConnection 名前を入力します。
  4. 一部のアプリでは、この接続をすべての権限（読み取り、書き込みなど）に適用するか、特定の権限のみに適用するかを選択できます。
  5. ［認証］をクリックします。
APIキー
API キー認証を作成するための手順ガイドは次のとおりです。
  1. ［設定 > Auth 権限］に移動し、［作成］をクリックします。
  2. 認証方式としてAPIキーを選択します。
  3. ［Auth 権限 名前］［項目 ラベル］［Parameter 名前］を入力し、API キーの配置場所と項目種類を選択します。



  4. テスト用の API 呼び出しを行い、接続が想定どおりに動作するか検証する必要がある場合は、［有効にする テスト URL］チェックボックスをオンにします 。［テスト URL］に URL を入力し、必要に応じて Params とヘッダーの値を指定してテスト URL を設定します。
  5. ［保存］をクリックします。
カスタム接続を作成するための手順ガイドは次のとおりです。
  1. ［設定 > 外部連携］に移動し、［作成 Connection］をクリックします。
  2. 表示される設定ウィンドウで、接続を作成するアプリを選択し、Auth 権限の下でそのアプリを選択して、［次］をクリックします。



  3. ［Connection 名前］と［項目 ラベル］の値を入力します。
  4. ［認証］をクリックします。

 
フローで送信 Webhook アクションを設定する

基本認証 / OAuth v1.0a / OAuth v2 / API キー:
  1. ビルダーで、［Logic］>［Webhook］に移動します。
  2. ほかのトリガーや処理と同様に、［Webhook を送信］アクションをドラッグ＆ドロップします。
  3. 表示される設定ウィンドウで、使用する接続を選択します。
  4. そのアプリへの接続がすでに存在する場合は、ドロップダウンから選択します。存在しない場合は、［新規］をクリックして新しい接続を作成します。
  5. ［Request］ドロップダウンからリクエストメソッド（GET/PUT/POST/PATCH/DELETE）を選択し、HTTP URLを入力します。HTTP URL は、利用するアプリの API ドキュメントを参照して取得できます。



    アプリの API がヘッダー、本文、またはクエリパラメーターによる認証に対応している場合は、該当するパラメーター名とパラメーター値（パラメーター値には、アプリケーションから取得した連携キーや API キーなどを指定できます）およびその他のヘッダー／本文パラメーターを、それぞれの項目に入力します。
  6. リクエスト本文で送信されるデータ形式を指定するコンテンツタイプをドロップダウンから選択します。通常は JSON を選択します。
  7. ドロップダウンメニューからレスポンス種別を選択します。レスポンス種別が XML または Auto の場合、操作内で XML レスポンスを JSON に変換したいときは、 ［XML を JSON に変換］チェックボックスをオンにします。
    レスポンスからヘッダー情報を取得し、マッピング用の変数として表示するには、［ヘッダーデータを表示］チェックボックス をオンにします。
  8. すべての必須項目の入力が完了したら、［保存］をクリックし、続けて［テスト］をクリックして、期待どおりに動作するか確認します。
メモ: 
  1. 同じ手順で NoAuth を設定できます。設定ウィンドウで（手順 3）、［認証なし ］を選択します。



  2. アプリケーションがオンプレミスにインストールされている環境に接続する必要がある場合は、［このアプリはオンプレミスにインストールされています］チェックボックスをオンにします。
  3. ドロップダウンメニューからオンプレミスエージェントを選択するか、［新規］をクリックして新しく作成します。
ヒント: 
  1. JSON レスポンス内の個々のキーは、設定を少なくとも 1 回テストした後にのみ、マッピングに使用できるようになります。



  2. エラーを防ぐため、設定ウィンドウで HTTP URL を入力する際はスペースを使用しないでください。