Pular para o conteúdo principal

Webhooks

Os webhooks permitem que você receba notificações programáticas em tempo real sobre a criação de remessas e alterações no rastreio. Em vez de consultar a API em intervalos regulares, a Magalog envia as informações diretamente ao endpoint configurado na sua aplicação.

Após o cadastro da URL e da inscrição, o webhook é associado ao tenant_id do cliente. Quando uma remessa desse tenant é criada ou tem o rastreio atualizado, uma notificação é enviada à URL cadastrada.

Para registrar um webhook, siga os passos da documentação de Webhooks.

🔔 Tópicos de Inscrição e Exemplos de Notificações​

Ao se inscrever para receber notificações do webhook, sua URL recebe mensagens referentes a tópicos específicos. Cada tópico está relacionado a um recurso e aos eventos que podem ocorrer nele.

Tópico Descrição Possíveis Status Exemplo de Mensagem
logistic_order_tracking_updated Eventos gerados na criação da remessa e nas atualizações de rastreio. A inscrição é associada ao tenant_id do cliente. Escopo: open:tracking:read SHIPPING_CREATED, IN_PREPARATION, WAITING_PICKUP, WAITING_POST, PICKED_UP, POSTED, PICKED_FAILURE, POSTED_FAILURE, IN_TRANSIT, TRANSPORT_PROBLEM, IN_ROUTE_PICKUP, IN_ROUTE_DELIVERY, DELIVERY_FAILURE, WAITING_WITHDRAW, DELIVERED, DIRECTED_TO_REFUND, CANCELED, REFATURATED, DIRECTED_TO_RETURN, WITHDRAWN, AUTHORIZATION_CODE_EXPIRED, AUTHORIZATION_CODE_CANCELLED, REVERSE_MANUALLY_COMPLETED, WAITING_INVOICE, READY_TO_SHIP 
{
  "data": {
    "params": {
      "code_id": "MLG261001Y8PQSYWIGL",
      "id": "1e23acf7-30b1-462e-b56d-e27266c323fc",
      "reference": "11222333-TESTE-EXEMPLO"
    },
    "resource": "/logistic/tracking/v1/shipment?code_id=MLG261001Y8PQSYWIGL",
    "status": "SHIPPING_CREATED",
    "type": "logistic_order_tracking_updated"
  },
  "tenant_id": "2df7eacd-1014-4c8d-9859-9ff9526ee5fd",
  "topic": "logistic_order_tracking_updated"
}

Receba Atualizações por Webhook​

Para configurar um webhook, siga a documentação do portal de desenvolvedores.

ℹ️ Observação

Esta inscrição é associada ao tenant_id do cliente e notifica apenas eventos de remessas desse tenant.