Message Start Event (Webhook)

Release date 2019-10-01

Issues a URL that awaits a Webhook (HTTP request) in a specified method, and starts a new Process automatically when a Webhook 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

Step Name
Note

Configs

API key *
- String-type (single-line)
Method of receiving HTTP request *
- GET
- POST
- PUT
- PATCH
- DELETE
Content-Type of receiving HTTP request *
- application/json
- text/xml
- application/x-www-form-urlencoded
Data item that will save the request body
- String-type (multiple-line)
- String-type (Markdown)
Content-Type of HTTP response *
- application/json;charset=UTF-8
- text/xml;charset=UTF-8
Body of HTTP response^#{EL}
- Insert reference…
  - Title
  - Process ID
  - Process Start User
  - Process Start Organization
  - Process Start Datetime
  - Process Sequence Number
  - App ID
  - App Name
  - (Data Items)

Capture

Notes

The value of the API key can be set arbitrarily with halfwidth alphanumeric characters, at most 100 in length (Auto-generation is also available)
There is a possibility that a process will not be started automatically due to the limit on the number of started processes over the entire Workflow platform
There is a possibility that a process will not be started automatically due to the size limit on data that can be received
- R2211: HTTP Communication Restrictions
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 in [IP Address Filtering] < [System Settings] (M312: System Administrator authority is required)
- You can restrict the source IP addresses that can access each trigger URL
You can check the incoming URL and details about the Task in the other page after clicking the button in the property screen