Pular para o conteúdo principal

Webhooks

Os webhooks permitem que você obtenha notificações programáticas em tempo real sobre alterações em seus dados à medida que elas acontecem. Em vez de extrair informações por meio de nossa API, os webhooks enviarão informações ao seu endpoint. Para registrar um webhook é necessário seguir os passos existentes na documentação.

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

Ao se inscrever para receber notificações do nosso webhook, sua URL receberá mensagens referentes a diferentes tópicos, cada um relacionado a um recurso específico. Abaixo está a definição de cada tópico disponível, juntamente com seus possíveis status e um exemplo de mensagem.

Tópico Descrição Possíveis Status Exemplo de Mensagem
orders_order Eventos gerados durante o ciclo de vida do pedido. Escopo: open:order-order-seller:read new, approved, cancelled, finished 
{
  "data": {
    "status": "new",
    "params": {
      "id": "1396270079555855"
    },
    "resource": "/seller/v1/orders/1396270079555812?updated_at__ge=iso-datetime"
  },
  "tenant_id": "3b5cf468-c858-404b-9e53-630e3df9d74a",
  "topic": "orders_order"
}

orders_delivery Eventos gerados durante o ciclo de vida de uma entrega. Escopo: open:order-delivery-seller:read shipped, approved, invoiced, cancelled, delivered 
{
  "data": {
    "status": "shipped",
    "params": {
      "id": "debde69a-2dbb-427b-b478-6cffd7930ece"
    },
    "resource": "/seller/v1/deliveries/debde69a-2dbb-427b-b478-6cffd7930ece?updated_at__ge=iso-datetime"
  },
  "tenant_id": "3b5cf468-c858-404b-9e53-630e3df9d74a",
  "topic": "orders_delivery"
}

Receba Atualizações por Webhook​

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