Webhookの通知内容について

Webhookで通知される内容について記載します。

Webhookの通知内容
基本情報

申請書の基本情報です。

項目名

説明

id

文字列

通知毎に割り当てられる固有ID

flow_status

文字列

経路の進行状況

flow - 申請中

decision - 決裁

remand - 差し戻し

reject - 却下

takeback - 取り消し

action_type

文字列

通知の種別

request - 申請時の通知

takeback - 取り消し時の通知

receive - 申請書受信時の通知

accept - 承認時の通知

confirm - 回覧確認時の通知

deny - 議決判定否認時の通知

reject - 却下時の通知

remand - 差し戻し時の通知

end - 完了時の通知

app_cd

数値

コラボフローのアプリケーションコード

process_id

数値

経路ID

form_id

数値

フォームID

form_version

数値

フォーム版番号

document_id

数値

文書ID

document_number

文字列

文書番号

document_title

文字列

文書タイトル

request_date

文字列

作成日時

end_date

文字列

完了日時


操作者情報

アクションを行ったユーザーの情報です。

項目名

説明

action_user.id

文字列

操作したユーザーの内部ID

action_user.loginid

文字列

操作したユーザーのログインID

action_user.name

文字列

操作したユーザーのユーザー名

action_user.email

文字列

操作したユーザーのメールアドレス(PC)

action_comment

文字列

操作ユーザーが入力したコメント


申請者情報

申請を行ったユーザーの情報です。

項目名

説明

request_user.id

文字列

申請したユーザーの内部ID

request_user.loginid

文字列

申請したユーザーのログインID

request_user.name

文字列

申請したユーザーのユーザー名

request_user.email

文字列

申請したユーザーのメールアドレス(PC)

represent_user.id

文字列

代理申請したユーザーの内部ID

※代理申請の場合

represent_user.loginid

文字列

代理申請したユーザーのログインID

※代理申請の場合

represent_user.name

文字列

代理申請したユーザーのユーザー名

※代理申請の場合

represent_user.email

文字列

代理申請したユーザーのメールアドレス(PC)

※代理申請の場合


申請部署情報

申請の部署情報です。

項目名

説明

request_group.id

文字列

申請部署のグループID

request_group.code

文字列

申請部署のグループコード

request_group.name

文字列

申請部署のグループ名



判定者情報

判定を行ったユーザーの情報です。

項目名

説明

determs[]

配列

通知する段階の判定者一覧

determs[].phase_title

文字列

判定段階名

determs[].determ_status

文字列

<判定>

undeterm - 未判定

accept - 承認

skip - スキップ

remand - 差し戻し

reject - 却下

deny - 否認

<回覧>

unconfirm - 未確認

confirm - 確認

determs[].determ_date

日時

判定日時

determs[].comment

文字列

判定コメント

determs[].determ_user.id

文字列

判定ユーザー内部ID

determs[].determ_user.loginid

文字列

判定ユーザーログインID

determs[].determ_user.name

文字列

判定ユーザー名

determs[].determ_user.email

文字列

判定メールアドレス

determs[].represent_user.id

文字列

代行判定者の内部ID

※代行判定者が判定した場合

determs[].represent_user.loginid

文字列

代行判定者のログインID

※代行判定者が判定した場合

determs[].represent_user.name

文字列

代行判定者名

※代行判定者が判定した場合

determs[].represent_user.email

文字列

代行判定者メールアドレス

※代行判定者が判定した場合



フォームの入力情報

申請内容の情報です。
※fidXXは、フォームに配置したパーツのIDになります。

項目名

説明

contents[].fidXX.label

文字列

パーツの値(申請書画面に表示されるパーツの値)

※リストメニュー、ラジボタンは項目名が表示されます。

contents[].fidXX.link

文字列

添付ファイルへのリンク

※添付ファイル、画像、Excel添付取込にのみ表示されます。

contents[].fidXX.value

文字列

パーツの値

※リストメニュー、ラジボタンは値が表示されます。

contents[].fidXX.type

文字列

パーツの種類

text - テキスト(一行) ノーマル

number - テキスト(一行) 数値型

money - テキスト(一行) 金額型

textarea - テキストエリア

date - 日付

time - 時刻

number_v2 - 数値

list - リストメニュー

checkbox - チェックボックス

radio - ラジオボタン

attachment - 添付ファイル

image - 画像

lookup - マスター連携

calculate - 自動計算

excelimport - Excel添付取込

label - ラベル

contents[].fidXX.checked

真偽値

チェックボックスのON/OFF

※チェックボックスにのみ表示されます。

contents[].fidXX.name

文字列

パーツ名



段階情報

差し戻し先の段階情報です。
差し戻し時のみ通知されます。

項目名

説明

phase_number

数値

差し戻し先の判定段階番号

phase_title

文字列

差し戻し先の判定段階名



通知内容の一覧

Webhookの通知内容は、通知の条件によって異なります。

通知条件

基本情報

操作者情報

申請者情報

申請部署

情報

判定者情報

フォームの

入力情報

段階情報

申請時

-

-

取り消し時

-

-

受信時

-

-

-

承認時

-

回覧確認時

-

否認時

-

却下時

-

-

差し戻し時

申請書の経路終了時

-

-

-



補足
各通知条件の通知内容について
申請者操作時のWebhookの通知内容について
判定者・回覧者操作時のWebhookの通知内容について
経路終了時のWebhookの通知内容について