Actions define the outgoing message(s)
| Field |
Description |
| Name |
Name the endpoint |
| Trigger |
If applicable, reference to the Trigger record |
| Polling |
If applicable, reference to the Polling record |
| Order |
The order in which this action should be handled |
| Endpoint |
Reference to the Endpoint record |
Configuration
| Field |
Description |
| Perform Action On |
Select on which record(s) this action should run. If Attachments or Related Records is selected, multiple messages could be send |
| Send attachment as |
Only applicable when "Perform Action On" is set to "Attachments".
- Default: This will use the Message Template to create the attachment body
- Binary: This will send the attachment as a binary body
- Binary multipart/form-data: This will send the attachment as form data rather than as part of a RESTful message
|
| Form field name |
Only applicable when "Send attachment as" is set to "Binary multipart/form-data". Set the name of the form-data field for the file data. |
| Form data fields |
Only applicable when "Send attachment as" is set to "Binary multipart/form-data". Add additional form-data fields to the request. |
| Related Records Table |
(When Related Records is selected) Choose the table in which the related records are stored |
| Related Records Query |
(When Related Records is selected) The query used for the records that should be send |
| Root JSON Path |
For polling, define the path where the records are located in the JSON message |
| Unique Key JSON Path |
The unique key (what makes the record unique) JSON path. Ex: $.id |
| Unique Key Field |
The field name in the table configured on the Polling record where the unique key should be searched. Ex: correlation_id |
Message
| Field |
Description |
| OpenAPI |
Select an OpenAPI document or use the import button to import a document from a URL |
| OpenAPI Operation |
Select an OpenAPI operation and click the 'Update action' button behind to update this action with the settings from the OpenAPI document |
| SOAP |
Check if the message should be send as a SOAP message |
| SOAP Action |
(When SOAP is checked) Set the SOAP action for this message |
| Relative URL |
The relative URL where the message should be send to |
| HTTP Method |
The HTTP method used for this message |
| Custom Headers |
Set custom headers |
| Message Template |
The template that will be used to create the request body. Variables should be decorated with ${}. Example: ${short_description} |
Error Handling
| Field |
Description |
| Retry If Failed |
If checked, failed messages will be retried every 5 minutes with a maximum of 3 tries |
| Run Sub Flow On Failure |
When checked the selected sub flow will trigger on a failed message. The sub flow needs the following input fields:
action (reference to the action record)
trigger (reference to the trigger record)
error_message (string) |
| Sub Flow |
The sub flow that should be triggered on a failed message |
UI Actions
| Button |
Description |
| Generate Mappings |
Generate mappings based on the message template |
| Link |
Description |
| Generate Sample JSON |
This will generate and show a sample request body based on the mapping |