ドキュメント Webhooks API

最終更新日： 2025年5月21日
  • トピック：

作成対象：

  • 開発者

Adobe Workfront のドキュメント Web フックは、Workfront が外部ドキュメントプロバイダーに対して認可された API 呼び出しを行う API エンドポイントのセットを定義します。これにより、誰でも任意のドキュメントストレージプロバイダー用のミドルウェアプラグインを作成できます。

Web フックベースの統合のユーザーエクスペリエンスは、Google Drive、Box、Dropboxなどの既存のドキュメント統合のユーザーエクスペリエンスに似ています。例えば、Workfront ユーザーは以下のアクションを実行できます。

  • 外部ドキュメントプロバイダーのフォルダー構造をナビゲート
  • ファイルを検索
  • ファイルを Workfront にリンク
  • 外部ドキュメントプロバイダーにファイルをアップロード
  • ドキュメントのサムネールを表示

参照の実装

新しい web フック実装の開発をすぐに開始できるように、Workfront では参照の実装を提供しています。このためのコードは https://github.com/Workfront/webhooks-app にあります。この実装は Java ベースで、Workfront がネットワークファイルシステム上でドキュメントに接続できるようにします。

Web フック統合の登録

Workfrontの 管理者は、Workfront 内で設定／ドキュメント／カスタム統合に移動して、会社のカスタム web フック統合を追加することができます。設定内のカスタム統合ページから、管理者は既存のドキュメント web フック統合のリストを表示することができます。このページから、統合を追加、編集、有効化、無効化することができます。統合を追加するには、「統合を追加」ボタンをクリックします。

使用可能なフィールド

統合を追加する際、管理者は以下のフィールドに値を入力します。

フィールド名説明
名前この統合の名前。
ベース API の URLコールバック API の場所。外部システムに対して呼び出しを行う場合、Workfrontはエンドポイント名をこのアドレスに追加します。 例えば、管理者が Base API URL の「https://www.mycompany.com/api/v1」を入力した場合、Workfront は次の URL を使用してドキュメントのメタデータを取得します：https://www.mycompany.com/api/v1/metadata?id=1234。
パラメーターのリクエストすべての API 呼び出しの文字列に追加されるオプションの値。例：access_type=offline
認証タイプOauth2 または ApiKey。
認証 URL（OAuth2 のみ）ユーザー認証に使用される完全な URL。Workfrontは、OAuth プロビジョニングプロセスの一環として、ユーザーをこのアドレスに移動させます。

メモ：Workfrontは、「state」パラメーターをクエリ文字列に追加します。 プロバイダーは、これを Workfront のリダイレクト URI に追加して、Workfront に返す必要があります。
トークンエンドポイント URL（OAuth2 のみ）OAuth2 トークンを取得するために使用される完全な API URL。これは、Webhook プロバイダーまたは外部ドキュメントプロバイダーがホストします。
クライアント ID（OAuth2 のみ）この統合用の OAuth2 クライアント ID。
クライアントシークレット（OAuth2 のみ）この統合用の OAuth2 クライアントの秘密鍵。
Workfront リダイレクト URI（OAuth2 のみ）これは読み取り専用のフィールドで、Workfront によって生成されます。この値は、この統合を外部のドキュメントプロバイダーに登録するために使用されます。

注意：認証 URL で前述したように、プロバイダは、リダイレクトを実行する際に「state」パラメータとその値をクエリ文字列に追加する必要があります。
ApiKey（ApiKey のみ）web フックプロバイダーに対して承認済み API 呼び出しを行うために使用されます。API キーは Webhook プロバイダーによって発行されます。