Skip to main content
POST
/
admin
/
workflows-executions
/
{workflow_id}
/
steps
/
failure
cURL
curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/steps/failure' \
-H 'Authorization: Bearer {jwt_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
  "transaction_id": "{value}",
  "step_id": "{value}"
}'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workflow_id
string
required

The workflows execution's workflow id.

Body

application/json

The details of changing a workflow execution's step status.

​
transaction_id
string
required

The workflows execution's transaction ID.

​
step_id
string
required

The ID of the step whose status was changed.

​
response
any

Sets the step's response. It accepts any type.

​
compensate_input
any

Sets the compensation function's input. It accepts any response.

​
action
enum<string>

Whether to invoke or compensate the step.

Available options:
invoke,
compensate

Response

OK

The details of failing the workflow step.

​
success
boolean
required

Whether the workflow step has failed successfully.