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. O dado que irá no atributo data respeitará o mesmo contrato que poderá ser obtido na rota de obtenção da pergunta/resposta pelo ID (https://services.magalu.com/v0/questions/{id}).

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
ps-chat-notification Notificações sobre as perguntas enviadas NEW, WAITING_MODERATION, WAITING_RESPONSE, REJECTED, REJECTED_RESPONSE, APPROVED, DELETED 
{
  "data": {
    "id": "630e3bbc950b052e8724491a",
    "status": "NEW",
    "channel": {
      "id": "dabdad5f-72d5-41d7-a1f8-96e94d170a5c",
      "alias": "magazineluiza."
    },
    "subject": {
      "id": "630e3bbc950b052e8724491b",
      "type": "product",
      "extra": {
        "name": "Camiseta",
        "description": "Cor azul",
        "url_img": "https://exemple-image-url.com",
        "url": "https://exemple-url.com"

      }
    },
    "identifiers": [
      {
        "name": "name-exemple",
        "value": "ABC123",
        "reference": "https://exemple.magalu.com/v0/portfolios/skus/12345-6789-101112"
      }
    ],
    "question": {
      "message": "Quando o produto será entregue?",
      "external_id": "630e3bbc950b052e8724491c",
      "when_at": "2023-10-01T10:00:00Z",
      "owner": {
        "name": "João Silva",
        "ref_key": "joaosilva",
        "customer_id": "123456-7890-312341"
      },
      "product": {
        "sku": "ABC123",
        "description": "Smartphone Galaxy",
      }
    },
    "answer": {
      "message": "O produto será entregue em até 5 dias úteis.",
      "external_id": "630e3bbc950b052e8724491d",
      "when_at": "2023-10-02T14:30:00Z",
      "owner": {
        "name": "Maria Santos",
        "external_id": "maria.santos"
      }
    },
    "moderation": {
      "status": "NOT_MODERATED",
      "when_at": "2023-06-27T18:56:28.445Z",
      "block_rules": []
    }
  }
}

Receba Atualizações por Webhook​

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