Exemplo de Payload JSON
{
"text": "Zedy | Pedido Z-03ZXG04QCP25 Pago",
"title": "Zedy | Pedido Z-03ZXG04QCP25 pago",
"image": "https://app.zedy.com.br/icon.png",
"actions": [
{
"name": "Pedido Z-03ZXG04QCP25",
"url": "https://app.zedy.com.br/admin/:idloja/salles/:idPedido"
}
],
"orderId": "Z-03ZXG04QCP25",
"platform": "ZedyCheckout",
"paymentMethod": "credit_card | pix | boleto",
"status": "waiting_payment | paid | refused | refunded",
"createdAt": "2025-04-03T14:39:34.976Z",
"approvedDate": "2025-04-03T14:43:01.000Z",
"refundedAt": null,
"customer": {
"name": "Fabríc....",
"email": "fa.....@gmail.com",
"phone": "....6499",
"document": ".....070",
"country": "BR"
},
"products": [
{
"id": 17130732,
"name": "Attracione Men (3 Unidade)",
"planId": 42201575817239,
"planName": "Default Title",
"quantity": 1,
"priceInCents": 12990
}
],
"trackingParameters": {
"src": null,
"sck": null,
"utm_source": "jLj67ee9d527703559cba828c4e",
"utm_campaign": "🥇CBO 03/04🥇|120220970676990221",
"utm_medium": "🥇CBO 03/04🥇|120220970679730221",
"utm_content": "Novo anúncio de Vendas|120220970679660221",
"utm_term": "Instagram_Reels"
},
"commission": {
"totalPriceInCents": 12990,
"gatewayFeeInCents": 324.75,
"userCommissionInCents": 12665.25
},
"address": {
"street": "Dante....",
"number": "5802",
"complement": "Casa ro....",
"neighborhood": "Faze.....",
"zipcode": "951....",
"city": "Caxia....",
"state": "RS",
"country": "BR"
},
"isTest": false
}
Descrição dos Campos
text: Mensagem curta de notificação.title: Título da notificação.image: URL da imagem de notificação.actions: Ações rápidas com nome e link direto para o pedido.orderId: ID do pedido.platform: Plataforma utilizada.paymentMethod:credit_card,pix,boleto.status:waiting_payment,paid,refused,refunded.createdAt,approvedDate,refundedAt: Datas em formato ISO.
Cliente (customer)
name,email,phone,document,country.
Produtos (products)
id: ID do produto.name: Nome.planId: ID do plano.planName: Nome do plano.quantity: Quantidade.priceInCents: Preço unitário em centavos.
Rastreamento (trackingParameters)
utm_source,utm_campaign,utm_medium,utm_content,utm_term.
Comissão (commission)
totalPriceInCents: Valor total em centavos.gatewayFeeInCents: Taxa do gateway.userCommissionInCents: Valor líquido.
Endereço (address)
street,number,complement,neighborhood,zipcode,city,state,country.
Teste (isTest)
Booleano indicando se a transação é teste.
Considerações Finais
Seu sistema precisa tratar campos null e estar preparado para mudanças de status em tempo real. Garanta que os dados sejam interpretados corretamente em cada evento recebido.
Se tiver dúvidas sobre a configuração do webhook ou integração com a Zedy, fale com nosso time de suporte.