機能仕様¶

Webhookの仕様や、送信されるデータの詳細について記載します。
詳細については、以下を参照ください。

リクエスト

レスポンス

リクエスト

項目説明

送信プロトコル HTTPS

送信メソッド POST

エンコード UTF-8

フォーマット JSON

送信データ

以下のデータがリクエストボディに設定されます。

案件の情報

案件の情報が設定されます。

キー説明型設定例備考

document_id 案件ID string A10007_20180521135125465 -

subject 申請件名 string 休暇届(2022/3/17) -

workflow_id ワークフローID string DF20100412135437671_3204 -

apply_form_id 申請フォームID string BD20100412135437671_3205 -

apply_form_name 申請フォーム名 string 休暇届ワークフロー -

form_id 帳票ID string DC20100401142650279_9732 -

form_name 帳票名 string 休暇届 -

route_id ルートID string FL20100401154738705_3371 -

number_for_apply 申請時に採番された申請番号 string 申請001 申請時採番が未設定の場合は、空文字列が設定されます。

number_for_decide 決裁時に採番された決裁番号 string 決裁001 決裁時採番が未設定の場合は、空文字列が設定されます。

number_for_complete 完了時に採番された完了番号 string 完了001 完了時採番が未設定の場合は、空文字列が設定されます。

important 重要かどうか boolean

true：重要案件

false：重要案件ではない

-

finish 完了案件かどうか boolean

true：完了案件

false：完了案件ではない

-

申請者の情報

申請者の情報が設定されます。

キー説明型設定例備考

applier_group_name 申請者のグループ名 string 第一営業部代理・代行申請の場合は依頼者の情報が設定されます。

applier_authority_name 申請者の役職名 string 一般同上

applier_user_id 申請者のID string A10007 「代理」申請の場合は「代理者」の情報、「代行」申請の場合は「依頼者」の情報が設定されます。

applier_name 申請者の氏名 string 坂戸若葉同上

applier_mail_address 申請者のメールアドレス string A10007@workflow.co.jp 同上

applier_comment 申請者のコメント string 休暇届を申請します -

applier_proxy_kind 申請者の種類 string

evident_proxy：代理申請

hidden_proxy：代行申請

代理・代行申請ではない場合は、空文字列が設定されます。

evident_proxy_applier_client_user_id 代理申請時の依頼者のID string A10007 代理申請ではない場合は、空文字列が設定されます。

hidden_proxy_applier_user_id 代行申請時の実処理者のID string A10011 代行申請ではない場合は、空文字列が設定されます。

ヒント

すべてのトリガーで設定されます。

現在の処理者の情報

現在の処理者（承認者／決裁者／閲覧者）の情報が設定されます。

キー説明型設定例備考

approver_group_name 現在の処理者のグループ名 string 第一営業部

代理・代行承認の場合は依頼者の情報が設定されます。

承認取戻し時は、取戻し操作を行った承認者の情報が設定されます。

申請、申請取戻し時は、空文字列が設定されます。

approver_authority_name 現在の処理者の役職名 string 課長同上

approver_user_id 現在の処理者のID string A10021

「代理」承認の場合は「代理者」の情報を、「代行」承認の場合は「依頼者」の情報が設定されます。

承認取戻し時は、取戻し操作を行った承認者の情報が設定されます。

申請、申請取戻し時は、空文字列が設定されます。

approver_name 現在の処理者の氏名 string 大泉淳二同上

approver_mail_address 現在の処理者のメールアドレス string A10021@workflow.co.jp 同上

approver_comment 現在の処理者のコメント string 承認します

否認、再申請請求、再承認請求、承認取戻し時は、該当操作時に入力したコメントが設定されます。

申請、申請取戻し時は、空文字列が設定されます。

approver_proxy_kind 現在の処理者の種類 string

evident_proxy：代理承認

hidden_proxy：代行承認

代理・代行承認ではない場合は、空文字列が設定されます。

evident_proxy_approver_client_user_id 代理承認時の依頼者のID string A10021 代理承認ではない場合は、空文字列が設定されます。

hidden_proxy_approver_user_id 代行承認時の実処理者のID string A10011 代行承認ではない場合は、空文字列が設定されます。

ヒント

「申請」、「申請取戻し」以外のトリガーで設定されます。

次の処理者の情報

次の処理者（承認者／決裁者／閲覧者）の情報が設定されます。

キー説明型設定例備考

next_approvers 次の処理者の情報 [{string…}]

次の処理者に代理・代行承認が設定されている場合は、依頼者と代理・代行者の情報がそれぞれ設定されます。(グループ名、役職名は必ず依頼者の情報が入ります)

再承認請求時は、差戻し先の承認者の情報が設定されます。

否認、再申請請求、申請取戻し、承認取戻し時は、設定されません。

同一AND承認グループ内のユーザー、現在の処理者と同一のユーザーは、設定されません。

{next_approver_group_name} 次の処理者のグループ名 string 第一営業部同上

{next_approver_authority_name} 次の処理者の役職名 string 部長同上

{next_approver_user_id} 次の処理者のID string A10030 同上

{next_approver_name} 次の処理者の氏名 string 高田尚文同上

{next_approver_mail_address} 次の処理者のメールアドレス string A10030@workflow.co.jp 同上

{next_approver_form_url} 承認フォームのURL string /receive/approve_form?id=QTEwMDAwXzIwMjIwMzE0MDgyNDE5MDAy&no=MDAwMDE%3D
ワークフローシステムのURL と組み合わせて、承認フォームを直接表示する場合に使用します。

例）http://[IPアドレスまたはホスト名]:8080/XFV20/receive/approve_form?id=QTEwMDAwXzIwMjIwMzE0MDgyNDE5MDAy&no=MDAwMDE%3D

{next_approver_proxy_kind} 次の処理者の種類 string

evident_proxy：代理承認

hidden_proxy：代行承認

代理・代行承認ではない場合は、空文字列が設定されます。

{next_proxy_approver_client_user_id} 次の処理者の代理・代行承認依頼者のID string A10015 次の処理者が通常承認の場合は、空文字列が設定されます。

ヒント

「否認」、「再申請請求」、「申請取戻し」、「承認取戻し」以外のトリガーで設定されます。

次の処理者が存在する場合に設定されます。

その他の情報

Webhookのトリガーなどの情報が設定されます。

キー説明型設定例備考

webhook_trigger トリガー string

apply：申請

approve：承認（すべての承認）

approve_decided：承認（決裁時のみ）

approve_finished：承認（完了時のみ）

deny：否認

ask_to_reapply：再申請請求

ask_to_reapprove：再承認請求

cancel_apply：申請取戻し

cancel_approve：承認取戻し

有効なトリガーのうち、Webhook送信の起点となったトリガーが設定されます。

例）「申請」と「承認（すべての承認）」のトリガーが有効な場合、申請時に送信されるWebhookには「apply」、承認時に送信されるWebhookには「approve」が設定されます。

approve_kind 承認種別 string

approve：承認

sanction：決裁

browse：閲覧

トリガーが「承認・決裁・閲覧」以外の場合は、空文字列が設定されます。

server_url ワークフローシステムのURL string http://localhost:8080/XFV20/ ワークフローシステムURL の入力値が設定されます。

ページTOPへ

送信データ例

{
   "document_id":"A10007_20180521135125465",
   "subject":"休暇届(2022/3/17)",
   "workflow_id":"DF20100412135437671_3204",
   "apply_form_id":"BD20100412135437671_3205",
   "apply_form_name":"休暇届ワークフロー",
   "form_id":"DC20100401142650279_9732",
   "form_name":"休暇届",
   "route_id":"FL20100401154738705_3371",
   "applier_group_name":"第一営業部",
   "applier_authority_name":"一般",
   "applier_user_id":"A10007",
   "applier_name":坂戸 若葉",
   "applier_mail_address":"A10007@workflow.co.jp",
   "applier_comment":"休暇届を申請します",
   "applier_proxy_kind":"hidden_proxy",
   "evident_proxy_applier_client_user_id":"",
   "hidden_proxy_applier_user_id":"A10011",
   "approver_group_name":"第一営業部",
   "approver_authority_name":"課長",
   "approver_user_id":"A10021"
   "approver_name":"大泉 淳二",
   "approver_mail_address":"A10021@workflow.co.jp",
   "approver_comment":"承認します",
   "approver_proxy_kind":"",
   "evident_proxy_approver_client_user_id":"",
   "hidden_proxy_approver_user_id":"",
   "next_approvers":[{
     "next_approver_group_name": "第一営業部",
     "next_approver_authority_name": "部長",
     "next_approver_user_id": "A10030",
     "next_approver_name": "高田 尚文",
     "next_approver_mail_address": "A10030@workflow.co.jp",
     "next_approver_form_url": "/receive/approve_form?id=QTEwMDAwXzIwMjIwMzE0MDgyNDE5MDAy&no=MDAwMDE%3D",
     "next_approver_proxy_kind": "evident_proxy",
     "next_proxy_approver_client_user_id": "A10015"
     },
     {
     "next_approver_group_name": "第一営業部",
     "next_approver_authority_name": "部長",
     "next_approver_user_id": "A10015",
     "next_approver_name": "後藤 健太郎",
     "next_approver_mail_address": "A10015@workflow.co.jp",
     "next_approver_form_url": "/receive/approve_form?id=QTEwMDAwXzIwMjIwMzE0MDgyNDE5MDAy&no=MDAwMDE%3D",
     "next_approver_proxy_kind": "",
     "next_proxy_approver_client_user_id": ""
   }],
   "number_for_apply":"申請001",
   "number_for_decide":"決裁001",
   "number_for_complete":"",
   "important":false,
   "finish":false,
   "webhook_trigger":"approve",
   "approve_kind":"sanction",
   "server_url":"http://localhost:8080/XFV20/"
}

レスポンス

リクエストには常にステータスコード200を返してください。
ステータスコード400,500番台は送信失敗扱いとなります。
リクエストには 60 秒以内に応答してください。超過した場合、送信失敗扱いとなります。
Webhookの送信に失敗しても、再送されません。

ページTOPへ