Webhookイベントを受信した時(トリガー)
このピースでできることSmartHR の接続方法サブドメインアクセストークンサンドボックス環境(任意)ピースの設定項目1. Webhook URL(表示のみ)2. セットアップ手順(表示のみ)取得できる情報出力例(抜粋)SmartHR側のWebhook設定手順SmartHRから届くWebhook本文(body)の例補足(受信時のバリデーション)
このピースでできること
- SmartHRからWebhookイベントを受信したタイミングで、ワークフローを起動します。
- 通知するイベントの種類(従業員作成・更新・退職など)は、SmartHR管理画面側で設定します。
SmartHR の接続方法
以下の2つを入力して接続します。
サブドメイン
SmartHR の URL のサブドメインを入力します。
例: URL が の場合、サブドメインは example です。
アクセストークン
- SmartHR 管理画面にログインします
- 「設定」→「外部システム連携」→「アクセストークン」 を開きます
- 「トークンを発行する」 をクリックします
- 利用する機能に応じてアクセス権限を設定します
- 従業員の取得・登録・更新を使用する場合は、従業員の参照・更新 と 部署・役職・雇用形態・事業所・給与支給形態の参照 を許可してください
- 発行されたアクセストークンをコピーし、接続画面の 「アクセストークン」 欄に貼り付けます
サンドボックス環境(任意)
テスト・検証用のサンドボックス環境を使用する場合はチェックを入れてください。本番環境では不要です。
ピースの設定項目
1. Webhook URL(表示のみ)
- フローごとに自動で生成されるWebhook URLです。
- SmartHR管理画面のWebhook設定画面に、このURLを登録します。
[設定例]
2. セットアップ手順(表示のみ)
- SmartHR側でWebhookを設定するための手順が表示されます。
[設定例]
取得できる情報
受信したWebhookの本文と、リクエストに付随する情報を取得します。SmartHRの通知内容は の中にあります。
| 実際のキー | 内容・条件 |
|---|---|
| / | SmartHRのイベント名・発生日時。いずれも文字列の場合に受け付けます。 |
| 通知元情報。受信本文に含まれる場合に利用できます。 | |
| イベントごとに届く追加情報。対象イベントと送信内容により異なります。 | |
| / | リクエストのヘッダー・クエリパラメータ。未指定のものは空です。 |
| 受信した生の本文。提供されている場合に含まれます。 |
- 本文の または が文字列でない場合は起動しません。
- 従業員などの詳細情報を別のAPIで追加取得する形式ではありません。実際に届いた本文のキーをテスト結果で確認してください。
- 例: で処理を分け、通知本文の値を後続ステップに渡せます。
出力例(抜粋)
後続ステップで使うキーを説明するための架空例です。実際の値や全項目を示すものではありません。
SmartHR側のWebhook設定手順
- SmartHR 管理画面にログインします。
- 共通設定 > 外部システム連携 > Webhook を開きます。
- 新規登録 をクリックし、フローの「Webhook URL」を入力します。
- 通知するイベントを選択して保存します。
SmartHRから届くWebhook本文(body)の例
補足(受信時のバリデーション)
- と が「文字列」として存在しない場合、そのWebhookは無視されます。