Criar workflow

Cria um workflow

Authorizations

Authorization

string

header

required

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

Body

application/json

Criar um workflow

name

string

required

Nome do workflow

content

object

required

Este objeto representa o conteúdo de um workflow, contém as declarações dos Nodes de fluxos e subfluxos de trabalho.

Show child attributes

content.trigger

object

required

Show child attributes

content.trigger.id

string

required

Identificador único do Node. Não pode conter caracteres especiais.

content.trigger.name

string

required

Nome do Node. Pode conter caracteres especiais.

content.trigger.type

enum<string>

required

Available options:

webhook-base39,

scheduled

content.trigger.parameters

object

required

• webhook-base39
• scheduled

Show child attributes

content.trigger.parameters.event

string

required

Example:

"loan.created"

content.trigger.parameters.enabled

boolean

default:true

Example:

true

content.actions

object[]

required

Show child attributes

content.actions.id

string

required

Identificador único do Node. Não pode conter caracteres especiais.

content.actions.name

string

required

Nome do Node. Pode conter caracteres especiais.

content.actions.type

enum<string>

required

Available options:

conditional,

execute-workflow,

function,

http-request,

loop,

sms,

smtp

content.actions.parameters

object

required

O node do tipo Conditional é responsável por realizar uma ou mais verificações, para então definir qual ramificação do fluxo seguir conforme o resultado obtido. As condições serão executadas na mesma sequência da declaração. Caso uma delas seja atendida, a execução encerra e o workflow é direcionado para o próximo subfluxo correspondente à condição verdadeira. Caso nenhuma condição seja atendida, o workflow segue para o subfluxo identificado como padrão.

• conditional
• execute-workflow
• function
• http-request
• loop
• sms
• smtp

Show child attributes

content.actions.parameters.conditions

array

required

content.actions.parameters.default

string

Identificador do subfluxo padrão que será executado caso nenhuma condição seja verdadeira.

content.subflows

object

Show child attributes

content.subflows.{key}

object[]

Show child attributes

content.subflows.{key}.id

string

required

Identificador único do Node. Não pode conter caracteres especiais.

content.subflows.{key}.name

string

required

Nome do Node. Pode conter caracteres especiais.

content.subflows.{key}.type

enum<string>

required

Available options:

lnch-condition,

http-request,

smtp,

function,

conditional,

loop

content.subflows.{key}.parameters

object

required

Configuração da condição de um subfluxo de Node Conditional.

• lnch-condition
• http-request
• smtp
• function
• conditional
• loop

Show child attributes

content.subflows.{key}.parameters.operator

enum<string>

default:and

Available options:

and,

or

content.subflows.{key}.parameters.expressions

object[]

Show child attributes

status

enum<string>

Status do workflow

Available options:

draft,

modified,

deployed

Example:

"draft"

Response

201 - application/json

Retorna o objeto `Workflow` se a criação for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos (por exemplo, especificar um documento inválido).

Este objeto representa um workflow. Ele permite que você crie fluxos de trabalho dinâmicos.

id

any

name

string

Nome do workflow

status

enum<string>

Status do workflow

Available options:

draft,

modified,

deployed

Example:

"draft"

content

object

Este objeto representa o conteúdo de um workflow, contém as declarações dos Nodes de fluxos e subfluxos de trabalho.

Show child attributes

content.trigger

object

required

Show child attributes

content.trigger.id

string

required

Identificador único do Node. Não pode conter caracteres especiais.

content.trigger.name

string

required

Nome do Node. Pode conter caracteres especiais.

content.trigger.type

enum<string>

required

Available options:

webhook-base39,

scheduled

content.trigger.parameters

object

required

• webhook-base39
• scheduled

Show child attributes

content.trigger.parameters.event

string

required

Example:

"loan.created"

content.trigger.parameters.enabled

boolean

default:true

Example:

true

content.actions

object[]

required

Show child attributes

content.actions.id

string

required

Identificador único do Node. Não pode conter caracteres especiais.

content.actions.name

string

required

Nome do Node. Pode conter caracteres especiais.

content.actions.type

enum<string>

required

Available options:

conditional,

execute-workflow,

function,

http-request,

loop,

sms,

smtp

content.actions.parameters

object

required

O node do tipo Conditional é responsável por realizar uma ou mais verificações, para então definir qual ramificação do fluxo seguir conforme o resultado obtido. As condições serão executadas na mesma sequência da declaração. Caso uma delas seja atendida, a execução encerra e o workflow é direcionado para o próximo subfluxo correspondente à condição verdadeira. Caso nenhuma condição seja atendida, o workflow segue para o subfluxo identificado como padrão.

• conditional
• execute-workflow
• function
• http-request
• loop
• sms
• smtp

Show child attributes

content.actions.parameters.conditions

array

required

content.actions.parameters.default

string

Identificador do subfluxo padrão que será executado caso nenhuma condição seja verdadeira.

content.subflows

object

Show child attributes

content.subflows.{key}

object[]

Show child attributes

content.subflows.{key}.id

string

required

Identificador único do Node. Não pode conter caracteres especiais.

content.subflows.{key}.name

string

required

Nome do Node. Pode conter caracteres especiais.

content.subflows.{key}.type

enum<string>

required

Available options:

lnch-condition,

http-request,

smtp,

function,

conditional,

loop

content.subflows.{key}.parameters

object

required

Configuração da condição de um subfluxo de Node Conditional.

• lnch-condition
• http-request
• smtp
• function
• conditional
• loop

Show child attributes

content.subflows.{key}.parameters.operator

enum<string>

default:and

Available options:

and,

or

content.subflows.{key}.parameters.expressions

object[]

Show child attributes

createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

createdBy

object

Esta estrutura de dados descreve a auditoria das operações de criação de faturas (invoices).

Show child attributes

createdBy.clientId

string

O clientId é o identificador da chave da API quando a operação de criação é realizada por um usuário ou o nome do tenant quando a operação é efetuada por um processo automatizado, evento ou outra fonte.

Example:

"key_643969122d598f5b62d15fbc"

createdBy.externalClientId

string

O campo externalClientId fornece informações adicionais ao clientId. É opcional e permite a inclusão de texto livre, sendo inteiramente responsabilidade do consumidor da API. Por exemplo, pode ser utilizado para incluir o identificador de um operador, empresa ou outro dado relevante.

Example:

"optr_643969122d598f5b62d15fbd"

updatedBy

object

Esta estrutura de dados descreve a auditoria das operações de alteração de faturas (invoices).

Show child attributes

updatedBy.clientId

string

O clientId é o identificador da chave da API quando a operação de alteração é realizada por um usuário ou o nome do tenant quando a operação é efetuada por um processo automatizado, evento ou outra fonte.

Example:

"key_643969122d598f5b62d15fbc"

updatedBy.externalClientId

string

O campo externalClientId fornece informações adicionais ao clientId. É opcional e permite a inclusão de texto livre, sendo inteiramente responsabilidade do consumidor da API. Por exemplo, pode ser utilizado para incluir o identificador de um operador, empresa ou outro dado relevante.

Example:

"optr_643969122d598f5b62d15fbd"