Create a new flow definition

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

Contains the flow definition

name

string

The flow name, it must follow the following regexp: ^[a-zA-Z_$][a-zA-Z_$0-9]*$

description

string

A brief description of what this flow is about

webhook

object

Contains information about the target endpoint that will be acting as a webhook

Show child attributes

webhook.url

string

The webhook endpoint, must be https

steps

object

Key-Value pair object that contains the steps that will consist on this workflow, the object Key must follow the following regexp: ^[a-zA-Z_$][a-zA-Z_$0-9]*$

NOTE: If you want to define a step with no additional configuration you can just define the step name with a null value. Example:

"steps": {
  "step_with_no_attributes": null
}

Show child attributes

steps.{key}

object

The step definition

Show child attributes

steps.{key}.repeatable

boolean

default:false

Boolean flag to indicate that this step can be run multiple times within the same flow

steps.{key}.depends_on

object

Indicates the required steps along with their respective exit codes that need to be met in order for this step to run. Example:

# step_b depends on step_a being executed with a success exit code
# step_c depends on step_b being executed with a success OR noop exit code
# step_d depends on step_b and step_c being executed with a success exit code

step_a:
   ...
step_b:
  depends_on:
    step_a: success
step_c:
  depends_on:
    step_b: success, noop
step_d:
  depends_on:
    step_b: success
    step_c: success

Show child attributes

steps.{key}.depends_on.{key}

string

steps.{key}.triggers

object

Indicates that after the execution of the step returing a certain exit code it will attempt to execute a following step. Example:

# After step_a executes with an exit code of success it will attempt to execute step_b
# A request to execute step_b has been received, since the dependencies have been meet it will execute it
# If step_b executes with an exit code of success OR noop it will attempt to execute step_c

step_a:
  triggers:
    success:
      - step_b
step_b:
  depends_on:
    step_a: success
  triggers:
    success, noop:
      - step_c
step_c:

Show child attributes

steps.{key}.triggers.{key}

string[]

Response

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

A simple response representation Successful response after creating or retrieving a flow definition

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 Contains the flow definition

Show child attributes

data.id

string

The flow definition identifier

data.name

string

The flow name, it must follow the following regexp: ^[a-zA-Z_$][a-zA-Z_$0-9]*$

data.description

string

A brief description of what this flow is about

data.webhook

object

Contains information about the target endpoint that will be acting as a webhook

Show child attributes

data.webhook.url

string

The webhook endpoint, must be https

data.webhook.signature_key

string

Key to ensure data authenticity (generated automatically)

data.steps

object

Key-Value pair object that contains the steps that will consist on this workflow, the object Key must follow the following regexp: ^[a-zA-Z_$][a-zA-Z_$0-9]*$

NOTE: If you want to define a step with no additional configuration you can just define the step name with a null value. Example:

"steps": {
  "step_with_no_attributes": null
}

Show child attributes

data.steps.{key}

object

The step definition

Show child attributes

data.steps.{key}.repeatable

boolean

default:false

Boolean flag to indicate that this step can be run multiple times within the same flow

data.steps.{key}.depends_on

object

Indicates the required steps along with their respective exit codes that need to be met in order for this step to run. Example:

# step_b depends on step_a being executed with a success exit code
# step_c depends on step_b being executed with a success OR noop exit code
# step_d depends on step_b and step_c being executed with a success exit code

step_a:
   ...
step_b:
  depends_on:
    step_a: success
step_c:
  depends_on:
    step_b: success, noop
step_d:
  depends_on:
    step_b: success
    step_c: success

Show child attributes

data.steps.{key}.depends_on.{key}

string

data.steps.{key}.triggers

object

Indicates that after the execution of the step returing a certain exit code it will attempt to execute a following step. Example:

# After step_a executes with an exit code of success it will attempt to execute step_b
# A request to execute step_b has been received, since the dependencies have been meet it will execute it
# If step_b executes with an exit code of success OR noop it will attempt to execute step_c

step_a:
  triggers:
    success:
      - step_b
step_b:
  depends_on:
    step_a: success
  triggers:
    success, noop:
      - step_c
step_c:

Show child attributes

data.steps.{key}.triggers.{key}

string[]

data.created_at

integer

When was this flow created

data.updated_at

integer

When was this flow updated

data.status

enum<string>

Indicates wether the flow is turned on or turned off

Available options:

active,

inactive

data.current_version

string

The version associated with this definition, this is only for traceability purposes, we do not support version rollbacks or anything like that

Get Started

FlowDefinition

FlowExecution

DeadLetter

Logs

Authorizations

Body

Response