Webhookイベントを受信した時(トリガー)

このピースでできること

  • SmartHRからWebhookイベントを受信したタイミングで、ワークフローを起動します。
  • 通知するイベントの種類(従業員作成・更新・退職など)は、SmartHR管理画面側で設定します。
 

SmartHR の接続方法

以下の2つを入力して接続します。

サブドメイン

SmartHR の URL のサブドメインを入力します。
例: URL が の場合、サブドメインは example です。

アクセストークン

  1. SmartHR 管理画面にログインします
  1. 「設定」→「外部システム連携」→「アクセストークン」 を開きます
  1. 「トークンを発行する」 をクリックします
  1. 利用する機能に応じてアクセス権限を設定します
      • 従業員の取得・登録・更新を使用する場合は、従業員の参照・更新部署・役職・雇用形態・事業所・給与支給形態の参照 を許可してください
  1. 発行されたアクセストークンをコピーし、接続画面の 「アクセストークン」 欄に貼り付けます

サンドボックス環境(任意)

テスト・検証用のサンドボックス環境を使用する場合はチェックを入れてください。本番環境では不要です。
 

ピースの設定項目

1. Webhook URL(表示のみ)

  • フローごとに自動で生成されるWebhook URLです。
  • SmartHR管理画面のWebhook設定画面に、このURLを登録します。
[設定例]

2. セットアップ手順(表示のみ)

  • SmartHR側でWebhookを設定するための手順が表示されます。
[設定例]

SmartHR側のWebhook設定手順

  1. SmartHR 管理画面にログインします。
  1. 共通設定 > 外部システム連携 > Webhook を開きます。
  1. 新規登録 をクリックし、フローの「Webhook URL」を入力します。
  1. 通知するイベントを選択して保存します。

受信ペイロード(例)

補足(受信時のバリデーション)

  • が「文字列」として存在しない場合、そのWebhookは無視されます。