Zoho DataPrepでは、Webhookを使用してパイプラインをトリガーできます。Webhookは、ソースサイトで特定のイベントが発生したときにトリガーされる、ユーザー定義のHTTPコールバックです。イベントが発生すると、ソースサイトは指定されたURLにHTTP要求を送信します。
簡単に言うと、Webhookは、外部アプリケーションのリアルタイムイベントを使用してDataPrepのパイプラインをトリガーするために使用されます。
Webhookを使用したパイプラインのトリガー
1. パイプラインの作成は、[ホーム]ページ、[パイプライン]タブ、または[ワークスペース]タブから行えます。50種類以上のソースからデータを取り込めます。
2. [パイプラインビルダー]ページで、データフローの作成と各ステージで必要な変換の適用が完了したら、データを1つ以上のエクスポート先にエクスポートできます。
3. パイプライン全体の作成が完了したら、
ヒント:[実行]ボタンを使用して、パイプラインのドライランを試すことをお勧めします。各実行はジョブとして保存されます。
パイプラインを実行すると、データソースから取得したデータに対して、各ステージで適用した一連の変換が行われ、その後データがエクスポート先にエクスポートされます。この一連のプロセスはジョブ履歴に記録されます。手動実行が正常に動作することを確認したら、[下書き]オプションを選択し、パイプラインを準備完了としてマークします。その後、パイプラインをトリガーするためのWebhookを設定できます。
メモ:パイプラインでは、一度に設定できる実行タイプは1つだけです。Webhookを使用してパイプラインをトリガーするには、[実行]ドロップダウンで[Webhooks]に設定する必要があります。
Webhooks設定
4. [スケジュール]ドロップダウンアイコンをクリックし、[Webhooks]オプションをクリックします。
Webhook設定
データに無効な値がある場合はエクスポートを停止:有効にすると、データに無効な値が残っている場合にエクスポートが停止します。
エクスポート順序
このオプションは複数のエクスポート先を設定している場合に、データをエクスポート先にエクスポートする順序を決定します。
有効にしない場合、エクスポートは既定の順序で実行されます。
メモ:このオプションは、パイプラインに複数のエクスポート先を追加している場合にのみ表示されます。
エクスポート先の順序変更
1) [エクスポート順序]トグルをクリックします。
2) ドラッグ&ドロップでエクスポート先の順序を変更し、[保存]をクリックします。
メモ:順序を再度変更する場合は、[順序を編集]リンクをクリックします。
失敗時の他のユーザーへの通知
このオプションでは、パイプラインが失敗したときに複数のユーザーに通知できます。トグルを有効にすると、[ユーザーを選択]オプションが表示されます。組織内のすべての有効ユーザーの一覧が表示されます。パイプラインが失敗した場合に通知するユーザーを選択できます。
メモ:上記で選択したユーザーに通知されるのは、各ユーザーが[通知設定]でパイプライン失敗通知を有効にしている場合のみです。
インポート設定
5. Webhooksを設定する際、すべてのソースに対してインポート設定を行う必要があります。インポート設定を行わないと、Webhooks設定を保存できません。
インポート設定を行うには、[こちらを編集]リンクをクリックします。
インポート設定はソースによって異なります。各種ソースのインポート設定方法について詳しくは、こちらをクリックしてください。
6. Webhooks設定が完了したら、[保存]をクリックします。
Webhookの仕組み
7. DataPrepでWebhookを有効にすると、受信HTTP要求を待ち受ける一意のURLが生成されます。要求を受信すると、このWebhookによって指定されたパイプラインがトリガーされるように設定されます。
外部サービスで、Webhookをトリガーするイベントを設定します。
たとえば、新しいデータの作成、既存データの変更、ファイルのアップロードなどをイベントにできます。次に、以下のAPI要求を使用して、特定のイベントが発生した場合にWebhook URLへHTTP要求を送信するWebhook実行を設定します。
Webhooks実行の作成
このAPIを使用して、Webhooks実行をトリガーします。
POST https://{{api_base_url}}/portals/{{portalname}}/pipelines/{{pipeline_id}}/webhook_run
|
パラメーター
|
型
|
説明
|
|
{{portalName}}
|
文字列
|
|
|
{{pipeline_id}}
|
整数
|
|
ヘッダー
サービス名:zohodataprep
スコープ:zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.削除, zohodataprep.dataprepapi.READ
メモ:このWebhookベースのパイプライン実行は1時間に4回のみトリガーできます。APIの詳細については、REST APIドキュメントを参照してください。
イベントが発生すると(たとえば、新しいファイルが追加された場合)、外部サービスがWebhook URLにHTTPリクエストを送信します。このリクエストはDataPrepのWebhookで受信され、関連付けられているパイプラインが実行されます。
8. Webhookは、パイプラインを開始するためのシグナルとしてのみ機能します。各Webhook実行はジョブとして保存されます。パイプラインが実行されると、データソースからデータが取得され、各ステージで適用した一連の変換を使用して準備された後、一定間隔でデータがエクスポート先にエクスポートされます。この一連の処理はジョブ履歴に記録されます。
9. 特定のパイプラインのジョブ一覧に移動するには、パイプラインビルダーで
省略記号アイコンに移動し、[ジョブ履歴]メニューをクリックしてパイプラインのジョブステータスを確認します。
10. 目的の ジョブIDを[ジョブ履歴]ページでクリックすると、特定のジョブの[ジョブの概要]に移動します。
[ジョブの概要]には、パイプラインフローで実行されたジョブの履歴が表示されます。詳細についてはこちらをクリックしてください。
メモ:実行されたすべてのジョブは[ジョブ履歴]に保存されるため、後で[ジョブ]ページで各パイプライン実行のステータスを確認できます。
11. Webhook実行が完了すると、パイプラインで準備されたデータが設定済みのエクスポート先にエクスポートされます。
メモ:パイプラインにさらに変更を加えると、その変更は下書きバージョンとして保存されます。[下書き]オプションを選択し、パイプラインを準備完了としてマークすると、変更がWebhook実行に反映されます。
Webhookを設定した後は、[編集]または[削除]を、パイプラインビルダーの[Webhooks有効]オプションから選択できます。
関連情報