Gerenciar Webhooks

Seus Webhooks

Nenhum webhook configurado

Crie seu primeiro webhook para receber notificações em tempo real sobre seus pedidos.

Documentação dos Webhooks

Eventos Disponíveis
  • order.created: Disparado quando um novo pedido (carta ou email) é criado no sistema
  • order.status_updated: Disparado quando o status de um pedido é alterado (processando, impresso, postado, etc.)
  • tracking.updated: Disparado quando novo código de rastreio é inserido no sistema e quando novas informações de rastreamento são atualizadas pelos Correios
  • rr.created: Disparado quando um novo Aviso de Recebimento (AR ou RR) é criado; o payload inclui o arquivo anexado em base64
Headers de Segurança
  • X-Webhook-Signature: Assinatura HMAC-SHA256 (quando configurado segredo)
  • X-Webhook-Event: Tipo do evento que disparou o webhook
  • X-Webhook-Delivery: ID único da tentativa de entrega
  • Content-Type: application/json
Exemplo de Payload
{
  "event": "order.created",
  "timestamp": "2025-01-15 10:30:00",
  "webhook_id": 123,
  "delivery_id": 456,
  "data": {
    "id": "240115001",
    "type": "letter",
    "status": 0,
    "recipient": {
      "name": "João Silva",
      "addr1": "Rua das Flores, 123",
      "city": "São Paulo",
      "state": "SP",
      "zip": "01234-567"
    },
    "value": 15.50,
    "created_at": "2024-01-15 10:30:00",
    "paymentMethod": "invoice"
  }
}