api.voa.delivery
Início
Início
  1. Webhook
  • Introduction
  • Authentication
  • Rate limit
  • Endpoints
    • v1
      • external-orders
  • Webhook
    • How does it work?
    • status
  1. Webhook

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.

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/
Modificado em 2026-04-29 21:11:10
Página anterior
external-orders
Próxima página
status
Built with