Receive Task (Webhook)

Release date 2019-10-01

Overview

Holds the token and awaits a webhook (HTTP request) at a specific URL. Advances the token when a webhook for the specified HTTP method is received. Capable of storing the received request body in a String-type Data Item. Also able to return an HTTP response with Business Data inserted.

Configs: Common

mode_edit_outline Step Name
mode_edit_outline Note

Configs: Request

arrow_drop_down API key *
- Data Type: String (single-line)
arrow_drop_down Method of receiving HTTP request *
- GET
- POST
- PUT
- PATCH
- DELETE
arrow_drop_down Content-Type of receiving HTTP request *
- application/json
- text/xml
- application/x-www-form-urlencoded
arrow_drop_down Data item that will save the request body
- Data Type: String (multiple-line)
- Data Type: String (Markdown)
arrow_drop_down Content-Type of HTTP response *
- application/json;charset=UTF-8
- text/xml;charset=UTF-8
mode_edit_outline Body of HTTP response^#{EL}
- arrow_drop_down Insert reference…
  - Title
  - Case ID
  - Case Start User
  - Case Start Organization
  - Case Start Datetime
  - Case Sequence Number
  - App ID
  - App Name
  - (Data Items)
Deadline
- arrow_drop_down
  - No deadline
  - After [Token Arrival/Case Start Time]
    - expand_all (select number 1-9999)
      - arrow_drop_down [Minute(s)/Hour(s)/Day(s)/Month(s)]
  - [00:00 of (Date-type)/(Datetime-type)]
    - expand_all (select number 1-9999)
      - arrow_drop_down [(blank: Cancel designation)/Minute(s)/Hour(s)/Day(s)/Month(s)]
- toggle_off Expression (Display the setting contents in EL expressions)

Capture

Notes

The incoming URL varies by Case
The API key in the incoming URL can be set with halfwidth alphanumeric characters, at most 100 in length
The incoming URL is notified to the request sender using a response of Message Start Event (Webhook)
Communication from external networks is not permitted in the default settings of the Workflow platform
- To allow communication from an external network, modify the settings at [IP Address Filtering] < [System Settings] (M312: System Administrator authority is required)
- You can restrict the source IP addresses that can access each incoming URL
You can check the incoming URL and details about the Task in the other page after clicking the button in the property screen
If the received HTTP request exceeds the size limit for data that can be received, reception fails and the standby state continues (the token stays)
- R2211: HTTP Communication Restrictions
Capable of setting a deadline
- Deadline times are displayed in Case Details and Lists and can be specified as a filter condition
If you specify anything other than “No Deadline”, the default will be set to “1 day after” the target time such as “Token Arrival”
- When specifying a Date-type Data Item, set it to “1 day after 00:00 of (Date-type) (24 hours later)”
  - This will behave the same as in Ver.16.2 and earlier, that is “If assigned to Deadline, it will work at 23:59 of the day on the relevant day”
  - If you select “Blank” in the “After days” dropdown, the operation will start at 00:00 on the specified date
  - If the calculated deadline falls on or after 2101-01-01, it will be forced to change to 2100-12-31
When you turn on [toggle_off Expression], the settings will be expressed in EL expressions
- Advanced settings are also possible by editing the EL expression
  - Example: processInstanceStartDatetime.addMonths(1).getFirstTimeInMonth() (00:00 on the first day of the month following the Case Start time)
Capable of advancing the token when the deadline is reached