For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks

Conecte a Troque & Devolva aos sistemas que aceitam webhook, como N8N e Zapier.

Criando um Webhook

Um webhook é uma forma de integrar sistemas diferentes, permitindo que informações sejam enviadas automaticamente de uma aplicação para outra quando algo acontece.

Na prática, ele funciona como uma notificação: quando um evento específico ocorre (como a criação de uma solicitação), o webhook envia os dados para uma URL configurada.

Na nossa plataforma, você pode configurar webhooks para eventos como:

  • Solicitação Criada: nova solicitação aberta pelo cliente.

  • Solicitação Negada: solicitação rejeitada.

  • Solicitação Autorizada: solicitação autorizada com envio.

  • Solicitação Autorizada com Descarte: autorizada sem a devolução dos itens.

  • Solicitação Autorizada com Devolução Pessoal: autorizada para entrega no centro de retorno.

  • Solicitação Postada: o cliente postou os itens.

  • Solicitação Entregue: os itens chegaram ao centro de retorno.

  • Solicitação com pagamento agendado: pagamento marcado para uma data futura.

  • Solicitação Concluída: solicitação encerrada.

  • Itens Recebidos no Centro de Retorno: conferência dos itens registrada.

  • Resposta de Email: o cliente respondeu a um e-mail da solicitação.

Dentro do painel Troque & Devolva, acesse Configurações > Webhooks. Será mostrada a listagem de eventos já existentes.

Listagem de webhooks configurados na Troque & Devolva

Para criar um novo, clique no botão Criar Webhook e preencha as informações em tela.

Preencha os campos:

  • Descrição: identificação do webhook, para você reconhecê-lo na listagem

  • URL do Webhook: o endereço que receberá os dados

  • Método HTTP: o método de envio, geralmente POST

  • Eventos para Escutar: quais eventos dispararão a chamada

  • Ativo: se o webhook está habilitado para disparar

Tela de criação de um webhook

Headers

O header Content-Type: application/json já vem preenchido. Adicione outros se o seu sistema exigir, como um token de autenticação.

Configurando Headers

Filtros condicionais

Você pode limitar o disparo a solicitações que atendam a determinadas condições, usando qualquer campo da solicitação. Clique em Adicionar Regra e monte a condição desejada.

É útil para, por exemplo, disparar o webhook apenas quando o valor da solicitação ultrapassar um limite ou quando a forma de pagamento for uma específica, evitando chamadas desnecessárias no seu sistema.

Configurando filtros condicionais

Dados enviados na chamada do Webhook

Ao receber o webhook, a depender de cada um dos eventos que você configurar, poderão ser enviados mais ou menos dados preenchidos. O ideal é que você realize testes.

De todo modo, a estrutura é semelhante a esse json:

Atualizado