How does it work?

A voa.delivery envia notificações automáticas para a sua URL de webhook cadastrada em nosso sistema sempre que há uma alteração relevante em um pedido.

Requisitos do seu endpoint

Método: POST

Deve responder com status HTTP 2xx (qualquer código entre 200-299)

Deve responder em até 5 segundos (timeout)

Qualquer resposta com status >= 300 ou timeout será tratada como falha

Headers enviados

Content-Type: application/json

User-Agent: VoaWebhook/1.0

Eventos

O campo event no payload indica o tipo de notificação. Eventos possíveis:

status_changed: O status do pedido foi alterado.

tracking_url_added: A URL de rastreio em tempo real foi gerada e está disponível.

delivery_requested: O pedido foi atrelado a uma chamada de entrega pela primeira vez. Enviado uma única vez por pedido e traz preferências de impressão da comanda (ex.: omitir o telefone do cliente).

Sobre o evento `delivery_requested`

Este evento é opcional e vem desligado por padrão. Pode ser habilitado para qualquer parceiro que solicitar ao suporte da voa.delivery.

Quando habilitado, ele é enviado uma única vez por pedido, no momento em que o pedido é atrelado a uma chamada de entrega. O payload inclui o campo omit_customer_phone:

omit_customer_phone (boolean): quando true, o telefone do cliente não deve ser impresso na comanda.

Sobre as trocas de status do pedido:

Entregador alocado: on_route_to_collect

Entregador aguardando produção: awaiting_production

Entregador em rota de entrega: on_route_to_delivery

Entrega realizada pela voa.delivery com sucesso: delivered

Entrega realizada pelo estabelecimento com sucesso: delivered_by_organization

Pedido cancelado: canceled

Retry

Nosso sistema tentará enviar até 5x a mensagem para o seu sistema com um delay inicial de 10s e máximo de 60s. Caso o seu sistema devolva qualquer status code acima de 299, a mensagem será descartada após as 5 tentativas.

Configure seu webhook

Envie ao suporte da voa.delivery (por ser pelo e-mail contato@voa.delivery) o endereço público e completo (conforme exemplo abaixo), no qual enviaremos um POST sempre que houver troca de status.

Exemplo: https://api.seusistema.com.br/

Requisitos do seu endpoint#

Headers enviados#

Eventos#

Sobre o evento delivery_requested#

Sobre as trocas de status do pedido:#

Retry#