AIに聞くお問い合わせピースをリクエスト
AIに聞くお問い合わせピースをリクエスト
workrun ヘルプサイト/文書の状態が変更された時（トリガー）

文書の状態が変更された時（トリガー）

このピースでできること

  • freeeサインで文書の状態（下書き・送信済み・締結完了など）が変わったときに、フローを自動で起動します。
  • 契約の締結を検知して、通知や台帳への記録などを自動化できます。

freeeサイン の接続方法

workrun と freeeサイン を接続するには、freeeサイン の OAuth クライアント（クライアントID・クライアントシークレット） が必要です。

ステップ 1：workrun のリダイレクト URL を確認する

  1. workrun で freeeサイン のアクション／トリガーをフローに追加します。
  1. 「接続を選択」の横にある 「＋ 新しい接続」 をクリックします。
  1. 接続画面に表示される 「リダイレクト URL」 をコピーしておきます。

ステップ 2：freeeサイン で OAuth クライアントを作成する

  1. freeeサインの管理画面にログインします。
  1. 画面右上の設定（歯車アイコン）を開きます。
  1. 「インテグレーション」セクションの「OAuth2.0 API クライアント」を開きます。
  1. クライアントを追加し、クライアント名とリダイレクトURIを入力します。
      • リダイレクトURIには、ステップ 1 でコピーしたリダイレクト URL をそのまま貼り付けてください。
  1. 発行された client_id（クライアントID） と client_secret（クライアントシークレット） をコピーしておきます。
スコープ一覧
スコープ名説明
allfreeeサインAPIの全エンドポイントへのアクセスを許可します。

ステップ 3：workrun に接続を追加する

  1. ステップ 1 の接続画面に戻り、クライアントID と クライアントシークレット をそれぞれ貼り付けます。
  1. 「接続」 をクリックすると、freeeサイン の認証画面が開きます。
  1. freeeサイン にログインし、workrun に対するアクセスを 「許可」 します。
  1. 画面が自動で閉じ、接続が完了します。

事前に必要な設定

freeeサインにはWebhookを自動で登録する仕組みがないため、freeeサインの管理画面で手動の登録が必要です。
  1. freeeサイン管理画面にログインします。
  1. 画面右上の設定（歯車アイコン）を開きます。
  1. 「インテグレーション」セクションの「Webhook」を開きます。
  1. トリガーの設定画面に表示されているWebhook URL を「URL」欄に貼り付けます。
  1. 「トリガーイベント」欄で「文書の状態変更」にチェックを入れます。
  1. 「不正リクエスト対策パスワード」欄に任意の文字列を入力して保存します。
  1. トリガーの「不正リクエスト対策パスワード」項目に、手順 6 で入力したものと同じ値を入力します。
フローを停止・削除する場合も自動では解除されないため、freeeサインの管理画面でWebhook設定を手動で削除してください。

ピースの設定項目

Webhook URL・設定手順は表示専用です。このトリガーでは接続（OAuth認証情報）の選択は不要です。

1. 不正リクエスト対策パスワード（必須）

  • freeeサイン管理画面のWebhook設定で入力した「不正リクエスト対策パスワード」と、まったく同じ値を入力します。
  • この値が一致しない場合、freeeサインからの通知を受け取ってもフローは起動しません。フローが起動しないときは、まずこの値が一致しているか確認してください。
[設定例]

取得できる情報

署名検証に成功し、通知の が の場合に、Webhookの本文を1件のデータとして後続のステップへ渡します。本文に含まれる追加の項目もそのまま利用できます。署名が一致しない場合や、別のイベントの場合はフローを起動しません。
キー内容・条件
イベントの種類。受け付ける値は document_status_changed です。
通知に含まれる文書情報。含まれる場合に利用できます。
文書ID・文書名。サンプルにある項目で、通知に含まれる場合に利用できます。
所有者ID・フォルダーID。通知に含まれる場合に利用できます。
文書の状態。通知に含まれる場合に利用できます。
文書の作成日時・更新日時。通知に含まれる場合に利用できます。

利用例

文書ID・文書名・状態を契約台帳へ記録したり、状態に応じてRouterで分岐して通知したりできます。

出力例（抜粋）

以下はサンプルの一部です。すべての通知で同じ文書項目が存在することを保証する例ではありません。
後続のステップでは などを直接参照します。 という階層ではありません。HTTPヘッダー・クエリパラメーター・元の本文文字列は後続へ渡しません。
文書の詳細を別途取得するピースではないため、使える項目は通知本文に含まれる範囲です。実際の状態変更でテストし、 配下の項目と状態値を確認してからマッピングしてください。