RESPOND_FAILURE
Responds to an incoming request with an error message. Action is loggable and can be used for failure tracking. Multiple RESPOND_ERROR actions can be called in a single data flow. Only the first encountered RESPOND_ERROR will actually be delivered to the client.
Properties
Code
response_errorCode
Response code used when an error was encountered while processing an inbound requests
Log Identifier
response_errorMessage
Message sent to clients when responding that an error was encountered. Also used as the identifier when recording the error log. Accepts template syntax. Error logs are searchable by this value. Please set this to make your error logs easier to interpret.
Error Severity
response_errorSeverity
Sets priority to error logs. Useful for categorizing and triaging error logs. Does not affect the response to the client.
| valid options | |
|---|---|
| INFO | A common occurrence. Use this for errors that are expected and occur during normal operation and do not usually require further review. |
| WARNING | Use this for errors that are expected, occur during normal operation, and likely need further review. |
| ERROR | An error has occurred. Use this for errors that are not expected to occur during normal operation. These should always be reviewed. |
| CRITICAL | A serious error has occurred. Use this for errors that indicate systemic issues which require immediate intervention. This may include unresponsive remote services or APIs. |
Log as System Error
response_logError
Enable to record the error log so that it may be reviewed in the admin panel.
Send Email
response_errorSendEmail
Enable to send an email message to an administrator when the error is encountered. It is recommended that this feature be used only for ERROR or CRITICAL level error messages to ensure that your inbox is not inundated with unnecessary messages.
Send Email To
response_errorSendEmailTo
The email address that will receive the error log notification.
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.
Error Topic
response_errorTopic
A topic to send email or SMS messages to notify of the error log. Topics can be set up for an account under the "Observers" menu in the admin panel. Topics allow notifications to be sent to multiple places rather than just a single email address.
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.