Listar workflows

Retorna todos os workflows.

Os itens são retornados e ordenados por data de criação, com os itens mais antigos primeiro.

Authorizations

Authorization

string

header

required

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

Query Parameters

expand

string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

limit

integer

default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

starting_after

string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

ending_before

string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

Response

200 - application/json

Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `Workflow` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de workflows.

hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

data

object[]

Uma lista de workflows

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

Show child attributes

data.id

any

data.name

string

Nome do workflow

data.status

enum<string>

Status do workflow

Available options:

draft,

modified,

deployed

Example:

"draft"

data.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

data.content.trigger

object

required

Show child attributes

data.content.trigger.id

string

required

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

data.content.trigger.name

string

required

Nome do Node. Pode conter caracteres especiais.

data.content.trigger.type

enum<string>

required

Available options:

webhook-base39,

scheduled

data.content.trigger.parameters

object

required

• webhook-base39
• scheduled

Show child attributes

data.content.trigger.parameters.event

string

required

Example:

"loan.created"

data.content.trigger.parameters.enabled

boolean

default:true

Example:

true

data.content.actions

object[]

required

Show child attributes

data.content.actions.id

string

required

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

data.content.actions.name

string

required

Nome do Node. Pode conter caracteres especiais.

data.content.actions.type

enum<string>

required

Available options:

conditional,

execute-workflow,

function,

http-request,

loop,

sms,

smtp

data.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

data.content.actions.parameters.conditions

array

required

data.content.actions.parameters.default

string

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

data.content.subflows

object

Show child attributes

data.content.subflows.{key}

object[]

Show child attributes

data.content.subflows.{key}.id

string

required

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

data.content.subflows.{key}.name

string

required

Nome do Node. Pode conter caracteres especiais.

data.content.subflows.{key}.type

enum<string>

required

Available options:

lnch-condition,

http-request,

smtp,

function,

conditional,

loop

data.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

data.createdAt

string

Data de criação do objeto

Example:

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

data.updatedAt

string

Data de alteração do objeto

Example:

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

data.deleted

boolean

default:false

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

Example:

false

data.createdBy

object

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

Show child attributes

data.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"

data.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"

data.updatedBy

object

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

Show child attributes

data.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"

data.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"