Message Start Event (Webhook)

Release date 2019-10-01

Overview

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

mode_edit_outline Step Name
mode_edit_outline Note

Configs

arrow_drop_down API key *
- String-type (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
- String-type (multiple-line)
- String-type (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)

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 Case 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