Webhook

Os webhooks permitem que você receba notificações em tempo real sobre eventos que ocorrem no sistema.

Configuração

Entre nas configurações da loja e cadastre o endpoint para onde o webhook será enviado.

Eventos

1. Pedido Criado

Disparado quando um novo pedido é criado no sistema.

Event: order.created

{
  "event": "order.created",
  "timestamp": "2025-10-22T14:32:18Z",
  "data": {
    "order_id": "12345678",
    "external_code": "external_code",
    "merchant_id": "1",
    "status": "Realizado",
    "created_at": "2025-10-22 11:32:18"
  }
}

2. Edição de Pedido

Disparado quando um pedido é editado no sistema.

Event: order.updated

{
  "event": "order.updated",
  "timestamp": "2025-10-22T14:32:18Z",
  "data": {
    "order_id": "12345678",
    "merchant_id": "1"
  }
}

3. Alteração de Status

Disparado quando o status de um pedido é alterado.

Event: order.updated_status

{
  "event": "order.updated_status",
  "timestamp": "2025-10-22T14:45:30Z",
  "data": {
    "order_id": "12345678",
    "merchant_id": "1",
    "status": "Em preparação"
  }
}

4. Avaliação de pedido

Disparado quando um cliente avalia um pedido.

Event: order.reviewed

{
  "event": "order.reviewed",
  "timestamp": "2025-10-22T15:20:45Z",
  "data": {
    "order_id": "12345678",
    "rating": "5",
    "comment": "Excelente atendimento! Comida deliciosa.",
    "reviewed_at": "2025-10-22 12:20:45"
  }
}

Segurança

Use HTTPS: Sempre configure URLs HTTPS para receber webhooks

Responda rapidamente: Retorne status 200 em até 30 segundos

Política de Tentativas

Se sua URL não responder ou retornar erro, o webhook irá fazer 5 tentativas automáticas a cada 30 segundos.

Configuração#

Eventos#

1. Pedido Criado#

2. Edição de Pedido#

3. Alteração de Status#

4. Avaliação de pedido#

Segurança#

Política de Tentativas#