Saltar para o conteúdo

Variáveis disponíveis num bloco ("Inserir variável")

GET/api/workflows/{id}/variables

Auth
Exige token
Chave de API:
workflows:read
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

(critérios 25, 25a e 26). Owner, admin, moderador e financeiro. As variáveis que chegam ao nó `nodeId` da versão mais recente, **agrupadas pelo bloco de origem**, na ordem do fluxo, só com os blocos **antes** dele: o gatilho (com o nome que a pessoa deu ao bloco, ou "Gatilho · {família}"), a pessoa (`member.*`, inclusive os campos do perfil `member.field.<chave>` com o nome do campo), a comunidade (`community.name`, `community.language`) e cada ação que vem antes em **todo** caminho (`steps.<nó>.result|skipped|reason`; `steps.<nó>.error` só no ramo de erro daquele passo). As variáveis declaradas pela pessoa (as do webhook de entrada, `trigger.<chave>`) vêm com o nome dela. Com `text`, `preview` traz o texto preenchido com os exemplos (Maria Souza, `[email protected]`).

Resposta: `{ nodeId, nodeType, groups: [{ source: trigger|member|community|step, nodeId, nodeType, trigger?, name, variables: [{ token: "{{purchase.product}}", name: "purchase.product", label, type: text|number|date|list|boolean, format?, options?, example, exampleText }] }], preview?: { channel, text } }`. `exampleText` é o exemplo como sai no texto ("R$ 197,00", "14 de novembro de 2026").

Parâmetros

NomeOndeTipoDescrição
idobrigatóriopathstring (uuid)
nodeIdobrigatórioquerystring
textopcionalquerystring
channelopcionalquerydm | html | slack

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respostas

CódigoDescrição
200As variáveis do nó, por bloco de origem (ver a descrição).
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Workflow ou nó não encontrado (`workflows.notFound`, `workflows.nodeNotFound`).
500Erro interno do servidor.

Exemplo com curl

curl -X GET "https://api.memberfy.net/api/workflows/<id>/variables" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"