Succeed a Step in a Workflow's Execution
Set the status of a step in a workflow's execution as successful. This is useful for long-running workflows.
In: header
Path Parameters
The workflows execution's workflow id.
Request Body
application/json
The workflows execution's transaction ID.
The ID of the step whose status was changed.
Sets the step's response. It accepts any type.
Sets the compensation function's input. It accepts any response.
Whether to invoke or compensate the step.
"invoke" | "compensate"Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X POST "https://{tenant}.api.myxclade.com/admin/workflows-executions/string/steps/success" \ -H "Content-Type: application/json" \ -d '{ "transaction_id": "string", "step_id": "string" }'{
"success": true
}{
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}"Unauthorized"{
"message": "Entity with id 1 was not found",
"type": "not_found"
}{
"code": "unknown_error",
"message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
"type": "QueryRunnerAlreadyReleasedError"
}{
"code": "invalid_request_error",
"message": "Discount with code TEST already exists.",
"type": "duplicate_error"
}{
"code": "api_error",
"message": "An error occured while hashing password",
"type": "database_error"
}Fail a Step in a Workflow's Execution
Set the status of a step in a workflow's execution as failed. This is useful for long-running workflows.
List Transaction Groups
Retrieve a list of transaction groups. The transaction groups can be filtered by fields such as `id`. The transaction groups can also be sorted or paginated.