This action sends application data or workflow information to an external partner system via an integration endpoint. It can be configured to run synchronously or asynchronously depending on the workflow requirement.
{
"args": {
"async": "true | false",
"endpointCode": "CODE"
},
"actionType": "INTEGRATION"
}
- Breaking Action: ✅ Typically yes if the workflow must wait for a successful push before continuing.
- Non-Breaking Action: ✅ Can be non-breaking if the push is optional and workflow can continue regardless of success.
-
Trigger
- This action is triggered during workflow transitions where application data needs to be sent to a partner system, such as RDB, banks, or other government agencies.
-
Execution
-
async: Determines whether the push is asynchronous (true) or synchronous (false).
true → workflow continues immediately without waiting for the partner response.false → workflow waits until the partner confirms receipt.
-
endpointCode: Specifies which pre-configured integration endpoint to use. This endpoint defines the target system and payload structure.
-
Dependencies
- The partner endpoint must be active and properly configured.
- Required application data fields must be present; missing fields may cause failures.
-
Integration
- The action can be used to send notifications, application details, or completed certificates to external systems.
- Supports multiple workflows using different
endpointCode values.
- Consider setting this as a breaking action if the partner system’s acknowledgment is critical.
- Use non-breaking mode for optional updates or notifications that should not block the workflow.
- Proper error handling and logging should be configured for failed integration attempts.