Como integrar webhooks ao seu formulário
Para integrar um webhook que envia dados de quando alguém envia um formulário, clique em Integrar, depois Webhooks
Clicando em Adicionar webhook irá abrir a tela para você configurar seu novo webhook
Yay! Forms também oferece recursos de segurança para melhorar a integridade e a confiabilidade das integrações do tipo webhook. Eles são:
Secret para Assinatura de Payload: Agora você pode especificar uma "Secret" que será usada para assinar o payload do webhook com HMAC SHA256. Isso permite que você verifique se o payload veio de fato do Yay! Forms, garantindo a autenticidade dos dados recebidos.
Verificação SSL: Adicionamos a opção de verificação SSL para as entregas de payloads. Ao marcar a opção "Verificar SSL", o Yay! Forms verificará os certificados SSL ao entregar os payloads, proporcionando uma camada adicional de segurança na comunicação.
Cabeçalho Personalizado: Para maior flexibilidade, agora você pode adicionar um "Custom Header" ao payload do webhook. Basta especificar o cabeçalho personalizado desejado e ele será adicionado ao payload enviado.
Essas funcionalidades aprimoraram a experiência do usuário e garantem a segurança das Webhooks no Yay! Forms. Para utilizar essas opções acesse o tela de edição da webhook:
Depois de configurar o seu webhook, você pode facilmente habilitá-lo ou desabilitá-lo clicando no botão abaixo. Além disso, pode ajustar as configurações ou testá-lo clicando nos três pontos e depois clicando em testar.
Essa opção avançada permite que os usuários escolham se desejam ou não acionar webhooks para envios de formulários passados, para fazer isso basta você habilitar a opção de Executar em Respostas anteriores como mostrado na imagem abaixo:
Esse recurso permite que os webhooks sejam acionados com base nas respostas dos usuários, garantindo integrações mais inteligentes e eficazes, para fazer isso basta você rolar até encontrar a sessão de Condição de acionamento como mostrado na imagem abaixo:
Caso você tenha interesse em entender melhor como funciona o nosso sistema de condicionais você pode acessar nosso arquivo de ajuda de Como Criar Expressões para Execução Condicional de Integrações.
É bom lembrar que por padrão o campo de condicional é sensivel a letras maiúsculas e minúsculas, ou seja Caso o usuario responda sim, e você tenha colocado Sim ele não irá enviar os dados do formulário, caso você queira que não tenha essa diferenciação entre maiúsculas e minúsculas você pode habilitar a opção Condição de acionamento sem distinção entre maiúsculas e minúsculas que se encontra abaixo da condição de acionamento.
O Yay! Forms oferece dois formatos de webhook ( V1 e V2), cada um com estruturas diferentes para atender necessidades específicas. Veja as diferenças:
Formato das respostas:
As respostas são enviadas em um array de objetos, onde cada objeto representa uma resposta individual.
Exemplo simplificado:
Formato das respostas:
As respostas são organizadas em um objeto com chaves únicas (IDs das respostas).
Exemplo simplificado:
Detalhes incluídos:
Com o V2 você poderá utilizar o Id do campo como chave de identificação do campo, que ajuda na forma como você fará o mapeamento dos campos.
Preencha o Formulário
Para que o teste seja enviado corretamente, é necessário que o formulário tenha pelo menos uma resposta válida preenchida.
Envio de Dados
O teste irá enviar os dados da última resposta válida preenchida.
Status de Envio
Por favor, note que o teste não marca a resposta como enviada na respectiva integração que está sendo testada. Este é apenas um procedimento para verificar a integração.
Esperamos que você goste da nova integração
Se você tiver alguma dúvida ou sugestão, envie um email para help@yayforms.com.
Clicando em Adicionar webhook irá abrir a tela para você configurar seu novo webhook
Yay! Forms também oferece recursos de segurança para melhorar a integridade e a confiabilidade das integrações do tipo webhook. Eles são:
Secret para Assinatura de Payload: Agora você pode especificar uma "Secret" que será usada para assinar o payload do webhook com HMAC SHA256. Isso permite que você verifique se o payload veio de fato do Yay! Forms, garantindo a autenticidade dos dados recebidos.
Verificação SSL: Adicionamos a opção de verificação SSL para as entregas de payloads. Ao marcar a opção "Verificar SSL", o Yay! Forms verificará os certificados SSL ao entregar os payloads, proporcionando uma camada adicional de segurança na comunicação.
Cabeçalho Personalizado: Para maior flexibilidade, agora você pode adicionar um "Custom Header" ao payload do webhook. Basta especificar o cabeçalho personalizado desejado e ele será adicionado ao payload enviado.
Essas funcionalidades aprimoraram a experiência do usuário e garantem a segurança das Webhooks no Yay! Forms. Para utilizar essas opções acesse o tela de edição da webhook:
Depois de configurar o seu webhook, você pode facilmente habilitá-lo ou desabilitá-lo clicando no botão abaixo. Além disso, pode ajustar as configurações ou testá-lo clicando nos três pontos e depois clicando em testar.
Recursos Avançados
1. Execução Opcional de Webhooks Passados
Essa opção avançada permite que os usuários escolham se desejam ou não acionar webhooks para envios de formulários passados, para fazer isso basta você habilitar a opção de Executar em Respostas anteriores como mostrado na imagem abaixo:
2. Envio Condicional com Base nas Respostas
Esse recurso permite que os webhooks sejam acionados com base nas respostas dos usuários, garantindo integrações mais inteligentes e eficazes, para fazer isso basta você rolar até encontrar a sessão de Condição de acionamento como mostrado na imagem abaixo:
Caso você tenha interesse em entender melhor como funciona o nosso sistema de condicionais você pode acessar nosso arquivo de ajuda de Como Criar Expressões para Execução Condicional de Integrações.
É bom lembrar que por padrão o campo de condicional é sensivel a letras maiúsculas e minúsculas, ou seja Caso o usuario responda sim, e você tenha colocado Sim ele não irá enviar os dados do formulário, caso você queira que não tenha essa diferenciação entre maiúsculas e minúsculas você pode habilitar a opção Condição de acionamento sem distinção entre maiúsculas e minúsculas que se encontra abaixo da condição de acionamento.
Entenda as Versões de Webhooks (V1 e V2)
O Yay! Forms oferece dois formatos de webhook ( V1 e V2), cada um com estruturas diferentes para atender necessidades específicas. Veja as diferenças:
Webhook V1
Formato das respostas:
As respostas são enviadas em um array de objetos, onde cada objeto representa uma resposta individual.
Exemplo simplificado:
"answers": [
{ "id": "65d4e7414e5adf68470edb9e", "content": "..." },
{ "id": "6273f707c63e7adf3c0203e3", "content": "..." }
]Webhook V2
Formato das respostas:
As respostas são organizadas em um objeto com chaves únicas (IDs das respostas).
Exemplo simplificado:
"answers": {
"65d4e7414e5adf68470edb9e": { "content": "..." },
"6273f707c63e7adf3c0203e3": { "content": "..." }
}Detalhes incluídos:
Com o V2 você poderá utilizar o Id do campo como chave de identificação do campo, que ajuda na forma como você fará o mapeamento dos campos.
Observações Importantes
Preencha o Formulário
Para que o teste seja enviado corretamente, é necessário que o formulário tenha pelo menos uma resposta válida preenchida.
Envio de Dados
O teste irá enviar os dados da última resposta válida preenchida.
Status de Envio
Por favor, note que o teste não marca a resposta como enviada na respectiva integração que está sendo testada. Este é apenas um procedimento para verificar a integração.
Esperamos que você goste da nova integração
Se você tiver alguma dúvida ou sugestão, envie um email para help@yayforms.com.
Atualizado em: 21/02/2025
Obrigado!