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:
request.created: Nova solicitação criada.
request.rejected: Solicitação rejeitada.
request.authorized: Solicitação autorizada.
request.posted: Solicitação postada.
request.delivered: Solicitação entregue.
request.done: Solicitação concluída.
Dentro do painel Troque & Devolva, acesse Configurações > Webhooks. Será mostrada a listagem de eventos já existentes.
Para criar um novo, clique no botão Novo Webhook e preencha as informações em tela.
Para configurar, você só precisa informar a URL que receberá os dados, selecionar os eventos desejados e, se necessário, adicionar headers e escolher o método de envio (geralmente POST).
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:
{
"_id": "6679a3721de31a0011825094",
"order": {
"buyer": {
"document": {
"number": "00000000000",
"type": "cpf"
},
"address": {
"country": "brasil",
"address": "Rua Do Endereço",
"number": "88",
"address2": "apto 101",
"postal_code": 81250280,
"neighborhood": "CIC",
"city": "Curitiba",
"state": "PR"
},
"id": "38011876",
"name": "Cliente de Teste",
"email": "[email protected]",
"mobile": "41999999999"
},
"shippment": {
"destination": {
"country": "brasil",
"address": "Rua Do Endereço",
"number": "88",
"address2": "apto 101",
"postal_code": 81250280,
"neighborhood": "CIC",
"city": "Curitiba",
"state": "PR"
},
"last_delivered": true,
"last_delivered_at": "2021-07-22",
"packages": [
{
"delivered": false,
"_id": "6679a3721de31a0011825096",
"carrier": "pac - Frete Grátis",
"tracking_number": "QF651787795BR",
"tracking_url": "",
"cost": 0,
"shipped_at": "2021-07-15T11:05:40.000Z",
"delivered_at": "2021-07-22"
}
]
},
"created_at": "2021-06-22T22:41:46.000Z",
"order_id": "654654333",
"order_number": "654654333",
"payment": [
{
"_id": "6679a3721de31a0011825095",
"amount": 355.96,
"detail": "Parcelas: 4"
}
],
"cart": [
{
"_id": "6679a3721de31a0011825097",
"sku": "SKU1",
"image": "https://troqueedevolva.com.br/test-store/sandalia.webp",
"link": "link",
"name": "Sandália de salto Anabela 36",
"quantity": 1,
"price": 199.9
},
{
"_id": "6679a3721de31a0011825098",
"sku": "SKU2",
"image": "https://troqueedevolva.com.br/test-store/vestido.webp",
"link": "link",
"name": "Vestido com cinto elegante",
"quantity": 1,
"price": 129
},
{
"_id": "6679a3721de31a0011825099",
"sku": "SKU3",
"image": "https://troqueedevolva.com.br/test-store/blazer.webp",
"link": "link",
"name": "Blazer longo alfaiataria bege",
"quantity": 1,
"price": 219
}
]
},
"request": {
"items": [
{
"pictures": [],
"_id": "6679a3721de31a001182509a",
"sku": "SKU1",
"image": "https://troqueedevolva.com.br/test-store/sandalia.webp",
"link": "link",
"name": "Sandália de salto Anabela 36",
"quantity": 1,
"price": 199.9,
"questions": [
{
"options": [],
"_id": "661180a35c83aa0011378701",
"required": true,
"area": "refund",
"question": "Qual o motivo da devolução?",
"value": "Não serviu"
}
],
"type": "refund"
}
]
},
"process": {
"status": 0,
"status_history": [
{
"_id": "6679a5cf1de31a00118489c7",
"to": 0,
"user": "customer",
"from": 0,
"message": "solicitação criada",
"updated_at": "2024-06-24T16:58:55.860Z"
}
],
"shippment_authorization": []
},
"createdAt": "2024-06-24T16:48:50.483Z",
"updatedAt": "2024-06-27T13:23:20.696Z",
}Atualizado
Isto foi útil?