Eventos de webhook - Cardapio Web API

Os eventos notificados são separados por módulos. No momento, apenas eventos do módulo de Pedidos são enviados. Para configurar a URL de recebimento, autenticação e retentativas, consulte Visão geral dos webhooks.

Para apps da CW App Store, os eventos são entregues na webhook_url configurada no app, após a instalação ativa do estabelecimento. Para integrações legadas, a entrega segue a URL cadastrada manualmente no Portal.

Eventos de pedidos

Todos os eventos de pedidos seguem a mesma estrutura de payload. As notificações trazem dados resumidos: use o order_id para consultar o pedido completo em Consultar detalhes do pedido.

Campo	Tipo	Descrição
`event_id`	string	Identificador único da notificação. Use para deduplicar eventos reenviados por retentativas.
`event_type`	string	Tipo do evento (`ORDER_CREATED` ou `ORDER_STATUS_UPDATED`)
`merchant_id`	number	ID do estabelecimento. Corresponde ao `company_id` usado no fluxo OAuth.
`order_id`	number	ID do pedido. Use na API para obter os detalhes completos.
`order_status`	string	Status atual do pedido. Consulte a referência da API para a lista completa de valores.
`created_at`	string	Data e hora do evento, em ISO 8601

Resumo dos eventos

`event_type`	Quando é enviado	Observações
`ORDER_CREATED`	Um novo pedido chega ao estabelecimento	Para mesas e comandas, é a única notificação (consulte abaixo)
`ORDER_STATUS_UPDATED`	O status de um pedido existente muda	Não se aplica a pedidos de mesas e comandas

Pedidos recebidos por integrações externas (iFood, 99Food, Keeta, Aiqfome) também geram eventos de webhook, assim como no polling de pedidos.

Pedidos de mesas e comandas: a Cardápio Web envia uma única notificação quando o pedido é cancelado ou finalizado, usando o tipo ORDER_CREATED. Não há eventos intermediários de ORDER_STATUS_UPDATED para esses pedidos. O order_status no payload reflete o status final (canceled ou closed).

Novo pedido (`ORDER_CREATED`)

Para pedidos comuns (delivery, retirada e similares), este evento é enviado quando um novo pedido chega ao estabelecimento. Exemplo

{
  "event_id": "067c677bf1c096ad7db136dc",
  "event_type": "ORDER_CREATED",
  "merchant_id": 3268,
  "order_id": 237456,
  "order_status": "waiting_confirmation",
  "created_at": "2023-06-22T19:04:20.292-03:00"
}

Status do pedido atualizado (`ORDER_STATUS_UPDATED`)

Este evento é enviado quando o status de um pedido existente é alterado. Não se aplica a pedidos de mesas e comandas. Exemplo

{
  "event_id": "016546b1f726a0e906f0f83e",
  "event_type": "ORDER_STATUS_UPDATED",
  "merchant_id": 2413,
  "order_id": 135466,
  "order_status": "canceled",
  "created_at": "2023-06-22T18:32:51.810-03:00"
}

​Eventos de pedidos

​Resumo dos eventos

​Novo pedido (ORDER_CREATED)

​Status do pedido atualizado (ORDER_STATUS_UPDATED)

Eventos de pedidos

Resumo dos eventos

Novo pedido (`ORDER_CREATED`)

Status do pedido atualizado (`ORDER_STATUS_UPDATED`)