Skip to main content
POST
/
flow
/
submit
Submits a flow execution
curl --request POST \
  --url https://api.indieflow.app/v1/flow/submit \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "flow_name": "<string>",
  "flow_id": "<string>",
  "step_name": "<string>",
  "data": {}
}
'
{
  "status": "success",
  "exit_code": "success",
  "data": {
    "flow_name": "<string>",
    "flow_id": "<string>",
    "step_name": "<string>",
    "data": {}
  },
  "request_id": "<string>"
}

Authorizations

​
X-Api-Key
string
header
required

The api key given to you when you register, no needed when using through RapidAPI

Body

application/json

Information about the flow to be created

The information about the flow that will get submitted

​
flow_name
string
required

The name of the flow we want to run

​
flow_id
string
required

The flow subject identifier

​
step_name
string
required

The name of the flow step we want to run

​
data
object

Any additional data we want to send (size is limited to 1kb)

WARNING: Avoid passing any sensitive data since its contents get stored

Response

The flow was successfully created, returns the id of the flow record

A simple response representation The response of the flow submission request

​
status
enum<string>

The response status returned from the server, it can be:

  • success: The request worked as expected
  • error: The request returned an error
Available options:
success,
error
​
exit_code
enum<string>

The response exit code returned from the server, it can be:

  • success: The request worked as expected
  • validation_error: The request contains an user input related error
  • unauthorized: Invalid credentials
  • generic_error: The request contains a generic error
  • service_down: The backend server is down
  • flow_disabled: The requested flow is currently marked as disabled
  • service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan
  • service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan
Available options:
success,
validation_error,
unauthorized,
generic_error,
service_unavailable,
resource_not_found,
step_already_executed,
flow_disabled,
service_plan_max_registered_flows_reached,
service_plan_max_steps_per_flow_reached
​
data
object

Schema that represents any serializable data The information about the flow that will get submitted

​
request_id
string

The generated request id