Webhooks na API FoodSoul: o CRM informa automaticamente seus serviços sobre novos eventos

Agora o FoodSoul envia notificações automaticamente para seus sistemas sempre que algo acontece no CRM. Por exemplo, quando chega um novo pedido, o cliente faz um pagamento ou recebe um reembolso, ou um novo hóspede se cadastra. Basta informar o endereço do seu serviço uma única vez, e os dados serão enviados imediatamente para o sistema de gestão, seu bot, outro CRM ou ferramenta de análise.

Sobre quais eventos é possível receber notificações

1. Novo pedido com ficha completa. Útil para o sistema de gestão, cozinha e análise.
2. Mudança de status do pedido. Ideal para o bot que informa o cliente sobre o pedido e para o call center.
3. Mudança de status do pagamento, incluindo reembolso. Necessário para contabilidade e controle financeiro.
4. Novo cliente e alteração de seus dados. Para CRM externo e serviços de envio de mensagens.
5. Crédito, débito e expiração de bônus. Para o programa de fidelidade e comunicação com os hóspedes.
6. Nova avaliação. Para o gerente e o departamento de qualidade.
7. Designação de entregador. Para logística e notificações ao cliente.
8. Alteração da lista de indisponibilidade. Para o site, cozinha e plataformas onde você vende.
9. A filial parou ou retomou o recebimento de pedidos. Para controle operacional e gestão da rede.

Você escolhe quais eventos deseja receber. É possível ativar apenas os necessários, como “novo pedido” e “pagamento”. Não encontrou o evento desejado? Escreva para nós — teremos prazer em adicioná-lo.

Como conectar

1. Ative os webhooks para a filial desejada — a chave de assinatura será criada automaticamente.
2. Escolha os eventos sobre os quais deseja receber notificações.
3. Informe o endereço do seu serviço para onde o FoodSoul enviará os dados. Apenas endereços HTTPS são aceitos.
4. Adicione a chave de assinatura ao serviço que recebe as notificações e configure a verificação da assinatura. Se você informou endereços diferentes ao criar os webhooks, adicione a chave em cada serviço.
5. Certifique-se de que o serviço confirma o recebimento da notificação em até 10 segundos, caso contrário, o FoodSoul irá reenviá-la.

6. Configure a verificação de duplicidade: a mesma notificação pode ser recebida várias vezes. Todas as duplicatas têm o mesmo ID (cabeçalho X-Webhook-ID). Seu serviço deve memorizar os IDs das notificações já processadas e ignorar as duplicatas — assim, um pagamento não será processado duas vezes.

    

Segurança: para que serve a chave de assinatura
 

O FoodSoul assina cada notificação com uma chave de assinatura — um conjunto de caracteres que só você e nós possuímos. Com essa assinatura, seu sistema verifica se a notificação veio do FoodSoul e se não foi alterada durante o envio.
 

Qualquer pessoa pode enviar uma solicitação para o endereço do seu serviço. Por exemplo, um fraudador pode enviar uma notificação falsa de “pedido pago”, e você pode acabar entregando um pedido não pago.
 

Com a assinatura, isso não acontece. Seu servidor calcula a assinatura com a mesma chave e a compara com a recebida. Se as assinaturas não coincidirem, a notificação é falsa ou foi alterada.

 

Se algo der errado

• Se seu serviço estiver temporariamente indisponível, o FoodSoul tentará entregar a notificação várias vezes ao longo de 10 horas. Uma breve falha ou reinicialização do servidor não resultará em perda de eventos.
• Se o problema persistir, a assinatura será desativada e você receberá um e-mail: assim, ficará sabendo do problema.
• Para reativar a assinatura, entre em contato com o suporte técnico. Lá também é possível reenviar as notificações que não foram entregues durante a falha.
   

Uma descrição detalhada dos eventos e do formato dos dados está na documentação da API.

Atenciosamente, equipe FoodSoul! Trabalhamos para você!