RESPOND_SUCCESS
Responds to an incoming request with a success message. Action is loggable and can be used for goal tracking. Multiple RESPOND_SUCCESS actions can be called in a single data flow. Only the first encountered RESPOND_SUCCESS will actually be delivered to the client.
Properties
Code
response_successCode
Response code used when successfully responding to inbound requests
Log Identifier ${}
response_successMessage
Message sent to clients when responding that the action was successful. Also used as the identifier when recording the success log. Accepts template syntax. Success logs are searchable by this value. Please set this to make your success logs easier to interpret.
Format
response_successFormat
The syntax used to format your response body.
| valid options | |
|---|---|
| JSON application/json | JSON (Javascript Object Notation). Common format for communication between computer systems. |
| Plain Text text/plain | The raw unparsed data in a text document |
| XML text/xml | Uses XML syntax and structure. Common format for communication between computer systems. |
| HTML text/html | Response is in HTML and is designed to be interpreted by a person viewing the results in a webpage |
| CSV text/csv | Comma delimited flat file. Use this when importing the data into spreadsheet software. |
Log as System Success
response_logSuccess
Enable to record the success log so that it may be reviewed in the admin panel.
Template ${}
response_template
The template used as the response body data. Accepts template syntax.
Use Template
response_useTemplate
Enable to use the template as the response data instead of the default preformatted field data.
Use Item Identifier
response_useItemIdentifier
Enable to record an identifier for a record the log applies to. This identifier will be stored on the produced log record and will allow the record to be searched by the identifier.
Item Identifier ${}
response_itemIdentifier
A template for the item identifier when recording an item identifier is enabled.
Fields
fields
A set of records that are used to define process data keys that are to be included when executing various actions.
Field Key
fields[].key
Where to find or set the data in the process data. Uses dot notation conventions.
Value ${}
fields[].value
The value to set in the process data. Accepts template syntax.