Como configurar Webhook
Um Webhook é essencial para integrar sistemas em tempo real, permitindo que eventos sejam acionados automaticamente e comunicados entre plataformas, garantindo agilidade e precisão nos processos.
Qual a função do Webhook?
Webhook é um mecanismo que permite a comunicação instantânea entre sistemas, enviando automaticamente dados assim que um evento específico ocorre, sem necessidade de consultas constantes. Isso possibilita integrações em tempo real, otimizando processos e mantendo os sistemas sempre atualizados.
Integração:
No menu principal da plataforma, selecione a opção "Integrações" no painel lateral esquerdo.
Você será direcionado para a tela com a lista de parceiros integráveis.
Localize e clique em "Webhooks" e, em seguida, clique em "Acessar".
Na tela seguinte, clique em "Criar Webhook".
Na nova tela à direita, preencha os campos “Nome do Webhook” e “URL do site”. Na seção "Selecionar eventos", você poderá associar eventos específicos ao Webhook.
Após preencher os campos conforme necessário, clique em "Criar Webhook".
O Webhook será criado e estará disponível na tela de Webhooks, onde você poderá visualizar informações como data de criação, nome e URL. Também será possível edita-lo ou exclui-lo.
Detalhes do payload enviado pelo webhook
Assinatura:
{
"id": "sub_example12345",
"account_id": "acc_exampleaccount123",
"order_id": "ord_exampleorder123",
"status": "INCOMPLETE",
"customer": {
"id": "cus_examplecustomer123",
"name": "João Silva",
"email": "joaosilva@example.com",
"document": "12345678900",
"phone": "11987654321"
},
"plan": {
"id": "prod_exampleplan123",
"name": "Anual",
"amount": 12000,
"currency": "BRL",
"interval": "YEARLY"
},
"payment_method": "CREDIT_CARD",
"current_period_start": "2025-05-01T00:00:00.000Z",
"installments": 12,
"line_items": [
{
"name": "Curso de Programação",
"description": "Acesso completo ao curso de programação",
"type": "SKU",
"quantity": 1,
"product_id": "prod_exampleproduct123",
"amount": 1000,
"full_amount": 12000,
"promotional_amount": 1000,
"image": "https://example.com/product_image.jpg",
"is_member_area": true,
"plan_id": "prod_exampleplan123"
}
],
"cancel_at_period_end": false,
"billing_cycle_count": 1,
"created_at": "2025-05-01T00:00:00.000Z",
"updated_at": "2025-05-01T00:00:00.000Z"
}Status no payload | Definição |
ACTIVE | A assinatura está ativa, com o pagamento confirmado com sucesso. |
CANCELED | A assinatura foi cancelada, encerrando a recorrência de pagamentos. |
INCOMPLETE | A assinatura está incompleta, aguardando a confirmação do pagamento. Pode ocorrer nos seguintes casos: Pix ou boleto gerado, mas ainda não pago; Cartão de crédito recusado. |
TRIAL | A assinatura está em período de avaliação gratuita (trial), antes da primeira cobrança. |
Pedidos:
{
"id": "ord_eloz1kotrd7jtghi5oa3vl",
"account_id": "acc_grlw5o8dp8rv2drenaio84",
"status": "PAID",
"customer_id": "cus_k2u8p87r2ikc07wo6xe081",
"provider": "ZOUTI",
"order_session_id": "os_nzvmq52nmbpiaqcazrq7et",
"amount_subtotal": 500,
"amount_total": 500,
"metadata": {},
"items": [
{
"amount": 500,
"description": "Teste Final",
"image_url": "https://zouti-core-media-public.s3.amazonaws.com/media/accounts/acc_grlw5o8dp8rv2drenaio84/products/images/icon_ry877mlixeg4frx3fm3gao_hq720-jpg",
"name": "Fique rico com bitcoin",
"product_id": "prod_eji9ptlqrlqk35etn3zfyi",
"quantity": 1,
"type": "SKU"
}
],
"customer": {
"document": "55629534041",
"email": "testewebhook@gmail.com",
"name": "teste webhook",
"phone": "11911111111"
},
"payment": {
"method": "PIX",
"interest_amount": 0,
"amount": 500,
"fee": 100,
"net_amount": 400
},
"utm_data": {},
"created_at": "2024-12-16T19:50:17.044Z",
"updated_at": "2024-12-16T19:50:17.044Z",
"amount_in_brl": 500,
"currency": "BRL"
}Satus de pagamento:
Nome payload | Nome na plataforma | Definição |
AWAITING_PAYMENT | Aguardando pagamento | Pedido via Pix ou boleto, aguardando confirmação. |
UNPAID | Não pago | Pagamento não concluído por recusa (cartão) ou expiração (Pix/boleto). |
PAID | Pago | Pagamento confirmado com sucesso. |
REFUNDED | Estornado | Valor devolvido ao cliente (manual ou automático). |
DISPUTED | Em disputa (chargeback) | Cliente contestou a cobrança com a operadora. |
TRIAL | Período de teste | Pedido gerado em assinatura com avaliação gratuita. |
CANCELED | Cancelado (obsoleto) | Status descontinuado, usado antes para pedidos não pagos. |
Métodos de pagamento:
Nome payload | Nome na plataforma | Definição |
CREDIT_CARD | Cartão de crédito | Quando o cliente usa o cartão como forma de pagamento. |
BOLETO | Boleto | Quando o cliente usa o boleto como forma de pagamento. |
PIX | Pix | Quando o cliente usa o Pix como forma de pagamento. |
Carrinho abandonado:
{
"id": "ab_d_mxyv2kjwl9apfr68btj3v9p",
"step": "PAYMENT",
"total_amount": 820,
"order_session_id": "os_6lq9gxh2v0xk1w4s7w8p2l",
"url": "https://pay.zouti-stage.com.br/infoproduct_cart_token/ab_d_mxyv2kjwl9apfr68btj3v9p",
"ip_address": "2001:db8:85a3:0000:0000:8a2e:0370:7334",
"currency": "BRL",
"customer": {
"name": "Lucas Oliveira",
"email": "lucas.oliveira@example.com",
"document": "12345678901",
"phone": "11987654321"
},
"metadata": {
"theme": "ZOUTI",
"payment_method": "CREDIT_CARD",
"checkout_type": "INFOPRODUCT"
},
"items": [
{
"type": "SKU",
"product_id": "prod_sample1234xyz",
"variant_id": "",
"name": "Curso de Desenvolvimento Web",
"description": "Acesso completo ao curso de desenvolvimento web",
"amount": 820,
"quantity": 1,
"image_url": "https://example.com/product_image.jpg"
}
],
"utm_data": {},
"account_id": "acc_sampleaccount5678",
"created_at": "2025-05-12T19:30:41.459Z",
"updated_at": "2025-05-12T19:30:41.459Z"
}Geração de Carrinho Abandonado
Cenário | Descrição | STEP | Significado do STEP |
Preenchimento parcial do checkout | Cliente preencheu dados pessoais (ao menos e-mail) e abandonou antes de escolher meio de pagamento. | PERSONAL_DATA | Preencheu dados pessoais, não escolheu meio de pagamento. |
Seleção de Pix ou boleto sem pagamento | Cliente gerou um Pix ou boleto, mas não efetuou o pagamento (expirou). | AWAITING_PAYMENT | Gerou Pix/boleto, mas não pagou (expiração). |
Recusa no cartão de crédito | Tentativa de pagamento via cartão recusada (pela adquirente ou antifraude). | REFUSED | Pagamento no cartão recusado. |
Abandono após escolher pagamento | Cliente escolheu a forma de pagamento (ex.: cartão, Pix ou boleto), mas não finalizou (não clicou em "Pagar" ou equivalente). | PAYMENT | Escolheu meio de pagamento, mas não concluiu a transação. |