対象サービス：WorkstyleOS Portal

対象者：管理者

 

Webhook を利用することで、WorkstyleOS で特定の操作が行われた場合に、その内容を外部サービスに送信できます。

本ページでは、WorkstyleOS の Webhook のトリガーの種類と設定方法について説明します。

 

Webhook のトリガー

WorkstyleOS の Webhook では３種類のトリガーを利用できます。

・アポイント/社内会議の作成・更新・削除

・WorkstyleOS Portal からの入館/退館処理

・入館証の発行

 

Webhook の発動パターン

アポイント/社内会議の作成・更新・削除

Webhook が発動するパターン

・WorkstyleOS Portal でアポイント/社内会議の作成・更新・削除時
・外部カレンダーでアポイント/社内会議の作成・更新・削除時
・ACALL mobile でアポイント/社内会議の作成・更新・削除時

 

Webhook が発動しないパターン

・CSVアップロードでアポイント/社内会議の作成時
・ACALL MEETING で社内会議の作成・更新・削除時

 

WorkstyleOS Portal からの入館/退館処理

Webhook が発動するパターン

・WorkstyleOS Portal からのゲストの入館処理/退館処理時

 

Webhook が発動しないパターン

 ・ACALL RECEPTION からのゲストの入館処理/退館処理時

 

入館証の発行

Webhook が発動するパターン

・ACALL RECEPTION から以下の入館証の印刷時
     アポイントの QRコード での受付
　 定期パス（入館証発行の設定が「メニューに従う」）の QRコードでの受付
　 アポイントなしでの受付

・WorkstyleOS Portal から入館証の印刷時

 

Webhook が発動しないパターン

・入館用紙の印刷時
・ACALL RECEPTION のアクション「イベント入場」を使用した入館処理後の入館証の印刷時

 

Webhook を作成する

WorkstyleOS Portal のサイドメニューから [ サービス連携 ] >  [ Webhook ] をクリックし、[ + 新規追加 ] をクリックします。

[ 設定 ] タブで各項目を入力したのち、[ 作成する ] をクリックします。

項目	内容
名前（＊）	Webhook の名前
URL（＊）	Webhook が発動した際の連携先サービス URL
署名検証トークン	[ 生成 ] をクリック ※トークンとして、ランダムな文字列が生成されます。
トリガー設定（＊）	Webhook のトリガーを選択
有効	Webhook の有効/無効を選択

⚠️ 注意
・（＊）は必須項目です。
・名前の重複登録はできません。

 

Webhook をテストする

作成した Webhook 編集画面の「テスト送信」タブより、テストを行うトリガーを選択して、[ テスト送信 ] をクリックします。

リクエスト・レスポンス内容が表示され、Webhook のテスト実行結果を確認できます。

 

Webhook を編集・削除する

WorkstyleOS Portal のサイドメニューから [ サービス連携 ]  >  [ Webhook ] をクリックし、編集したい Webhook の [ 編集 ] アイコンをクリックします。

Webhook の設定を変更したのち、 [ 更新する ] をクリックしてください。

 

削除する場合は [ 削除する ] をクリックしてください。