Webhookイベントを受信した時（トリガー）
このピースでできることfreee会計 の接続方法事前準備：freee アプリの登録接続手順ピースの設定項目1. Webhook URL（表示専用）取得できる情報利用例出力例（抜粋）freee側のWebhook設定手順テスト方法Webhookペイロード例
このピースでできること
- freee会計からWebhookイベントを受信したときに、フローを自動で起動します。
freee会計 の接続方法
OAuth2 で認証します。事前に freee アプリストアでアプリケーションを登録する必要があります。
事前準備：freee アプリの登録
- freee アプリストア（開発者向け） にログインします
- 「新しいアプリを作成」 をクリックします
- アプリ名などの必要事項を入力します
- コールバック URL の欄に、接続画面に表示されている リダイレクト URL を貼り付けます
- 「登録」 をクリックして保存します
- 発行された クライアントID と クライアントシークレット をコピーします
接続手順
- 接続画面でコピーした クライアントID と クライアントシークレット を入力します
- 「接続」 をクリックします
- freee のログイン画面が表示されるので、アカウントでログインします
- 連携する 事業所 を選択して 「許可する」 をクリックします
ピースの設定項目
Webhook URLと設定手順が表示されます。どちらも表示専用で、入力する設定項目と接続（認証情報）の選択はありません。
1. Webhook URL（表示専用）
- フローを有効化するとWebhook URLが発行されます。
- freee開発者ページのWebhook設定で、このURLを「URL」欄に貼り付けてください。
取得できる情報
freeeから受信したWebhookの本文・ヘッダーなどを、1件のデータとして後続のステップで利用できます。 と の両方が文字列である通知が対象です。欠落している場合や、文字列でない場合はフローを起動しません。
| キー | 内容・条件 |
|---|---|
| Webhookの本文。業務データはこの配下を参照します。 | |
| 受信したHTTPヘッダー。含まれるキーは送信内容によって変わります。 | |
| Webhook URLに付けられたクエリパラメーター。指定がなければ空のオブジェクトです。 | |
| 受信したHTTPメソッド。 | |
| 受信本文の元の文字列。受信形式によっては含まれません。通常の転記には body 配下を利用します。 | |
| 通知対象の種類。文字列である必要があります。 | |
| 通知対象の操作。文字列である必要があります。 | |
| ID・日時・対象データなど、通知本文に実際に含まれる項目。イベントによってキーと階層が変わります。 |
このピースは が会計の種類かどうかでは絞り込みません。受信したいイベントはfreee側のWebhook設定で選択してください。
利用例
通知対象の種類・操作でRouterを分岐し、通知に含まれるIDを後続の取得処理や台帳への記録に利用できます。
出力例（抜粋）
以下は返却される階層を示す例です。 は通知例の値で、すべてのイベントに共通する値ではありません。
対象データをAPIで追加取得するピースではないため、取得できる項目は通知本文に含まれる範囲です。固定の業務項目一覧はありません。workrunの「テストトリガー」で実際の通知を受信し、 配下のキーと値を確認してからマッピングしてください。
freee側のWebhook設定手順
- 対象のアプリケーションを選択し、「Webhook設定」タブを開きます。
- workrunで表示されたWebhook URLを「URL」欄に貼り付けます。
- 通知するイベントを選択して保存します。
テスト方法
- フローをトリガーせずにサンプルデータを生成する場合は、Webhook URLに「/test」を追加してください。
[設定例]