Eventos
Gateway Fluid
Gateway Fluid - v1 (legado)
6 min
esta é a documentação da v1 (versão 1, legada) do fluid api gateway para a documentação da última versão v2 , acesse gateway fluid docid\ tldeo0voi8xwt2iqj7oiv para disparar um evento/ webhook para fluid para iniciar a execução de um fluxo, é necessário fazê lo via gateway o gateway host é um endereço de acordo com os workspaces docid\ bqstxq1kzn1hn1c3fxv2z definidos para cada cliente consulte o o seu gateway host com a nossa equipe disparando um evento assíncrono um evento/ webhook para executar um fluxo de forma assíncrona retorna 200 como http status code e o eventid gerado na plataforma curl location '{gateway host}/flows/{flow name}?key={api key}' \\ \ header 'content type application/json' \\ \ data '{ "teste" "body" }' disparando um evento síncrono um evento/ webhook para disparar um fluxo de forma síncrona vai manter a requisição aberta até obter a resposta assim que finalizar a execução do fluxo eventos/ webhooks síncronos devem ser usados com fluxos com tempo de resposta de até 29 segundos caso o fluxo leve 29 segundos ou mais para finalizar, deverá ser usado o disparo assíncrono curl location '{gateway host}/flows/{flow name}/sync?key={api key}' \\ \ header 'content type application/json' \\ \ data '{ "teste" "body" }' definir o response resultante de um fluxo síncrono no evento síncrono , para retornar um response , é necessário informar o nome do passo do fluxo que gerará o retorno, através do parâmetro de query return step , como no exemplo abaixo curl location '{gateway host}/flows/{flow name}/sync?return step={step name}\&key={api key}' \\ \ header 'content type application/json' \\ \ data '{ "teste" "body" }' caso o retorno do passo seja um array de objetos , será necessário adicionar um parâmetro chamado return array com valor true , como no exemplo abaixo shel curl location '{gateway host}/flows/{flow name}/sync?return step={step name}\&return array=true\&key={api key}' \\ \ header 'content type application/json' \\ \ data '{ "teste" "body" }' setar o header content type do response no evento síncrono , por padrão, o content type do response é application/json caso seja necessário setar um outro valor para este header , passe por parâmetro de query hct (header content type), como no exemplo abaixo curl location '{gateway host}/flows/{flow name}/sync?key={api key}\&hct=application/vnd vtex checkout minicart v1%2bjson' \\ \ header 'content type application/json' \\ \ data '{ "teste" "body" }'