HTTP

É a configuração padrão de entrada do Firehose. É possível enviar mensagens para uma ou mais configurações de Firehose específicas criadas previamente.

O campo id retornado ao criar a configuração do Firehose na etapa anterior deve ser utilizado como parâmetro de cada mensagem enviada ao Firehose. Ele é responsável por mapear cada mensagem trafegada com a respectiva configuração à qual ela pertence.

Exemplo de requisição para enviar mensagens ao Firehose:

curl --location '<HOST>/v1/webhook?firehose-ids=FIREHOSE-ID,FIREHOSE-ID-2' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <ACCESS-TOKEN>' \
  --data '{
    "message": "TEXT"
  }'

Observe que é possível passar um ou mais IDs de configuração do Firehose no parâmetro firehose-ids da requisição (os diferentes IDs devem ser separados por , (vírgula)).

O header Content-Type é obrigatório pois o Firehose trafega os dados em bytes e é preciso saber o tipo do dado no momento da entrega.

Configurações adicionais

Alguns campos podem ser adicionados nos headers da mensagem enviada ao Firehose para definir alguns comportamentos dependendo do tipo de saída configurada.

Para cada umas das saídas os campos permitidos são os seguintes:

Tipo de Saída	Campo	Descrição	Exemplo	Valor Default
SFTP, EMAIL, AWS_S3 e AZURE_BLOB	file-path	Caminho do arquivo a ser gerado	upload/file.json	<firehose_correlation_uuid>.<extensão do Content-Type>
SFTP	file-codec	Forma na qual o arquivo será escrito no servidor SFTP. Permite dois tipos: lines: Arquivo único com anexo de linhas; all-bytes: Um arquivo para cada mensagem - O arquivo é sobrescrito caso já exista.	all-bytes	all-bytes