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_conversation Notificações sobre as perguntas enviadas New 
{
  "data": {
    "id": "630e3bbc950b052e8724491a",
    "status": "NEW",
    "subject": {
      "id": "id-001",
      "type": "offer",
      "extra": {
        "name": "Camiseta",
        "description": "Camiseta gola v na cor verde",
        "url_img": "https://www.magazineluiza.com/camiseta-gola-v_imagem.jpg",
        "url": "https://www.magazineluiza.com/camiseta-gola-v"
      },
      "custom_fields": [
        {
          "name": "Cor",
          "value": "Verde"
        }
      ],
      "identifiers": [
        {
          "name": "openapi",
          "value": "a11d50a5-31c1-4e9d-bbe3-27a59f944508",
          "reference": "https://api-internal.magalu.com/v0/portfolios/skus/a11d50a5-31c1-4e9d-bbe3-27a59f944508"
        }
      ]
    },
    "question": {
      "message": "Quais as outras cores?",
      "when_at": "2023-06-27T18:56:28.445Z",
      "owner": {
        "name": "Fluano da Silva (cliente)",
        "external_id": "cli-001"
      }
    },
    "answer": {
      "message": "Temos em três  cores azul, amarelo e vermelho.",
      "external_id": "resposta-01",
      "owner": {
        "name": "Joseph Climber",
        "external_id": "j.climber"
      },
      "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