O que é Webhook?
Webhook é um mecanismo que permite que um sistema envie informações automaticamente para outro sistema assim que um evento acontece. Funciona como uma notificação em tempo real, onde um serviço dispara dados para uma URL configurada sempre que ocorre um evento.
Exemplo: ao vender um curso online, a plataforma envia automaticamente um webhook para a área de membros após a confirmação do pagamento, liberando o acesso sem necessidade de ação manual. Também é possível disparar e-mails automáticos com dados de acesso, melhorando a experiência do cliente.
Configurando Webhook
Para criar um webhook, acesse Integrações → Webhooks e clique em Criar Webhook. Uma nova aba será aberta para configurar os eventos.
Campos de configuração:
-
Nome: apenas para organização interna
-
URL do Webhook: endereço que receberá o evento (ex: https://meusite.com/webhooks/)
-
Token: opcional, usado para autenticação das mensagens
-
Produto: produtos responsáveis pelo disparo
-
Evento: motivo do disparo (pode selecionar um ou vários)
Após a integração, o webhook aparecerá listado. Em Ver logs, é possível visualizar todos os eventos enviados.
Exemplos de notificações
Abaixo listamos alguns exemplos dos retornos possíveis com nossas mensagens:
- Boleto gerado:
{
"event": "BANK_SLIP_GENERATED",
"event_description": "Boleto gerado",
"checkout_id": "Q8J1N6K3",
"sale_id": "D2RP8RQ7",
"payment_method": "BANK_SLIP",
"total_price": "R$ 169,80",
"type": "ONE_TIME",
"status": "PENDING",
"created_at": "2023-12-18 16:37:45",
"customer": {
"name": "João da Silva",
"document": "23875090127",
"email": "exemplo@email.com",
"phone_number": "5511987654321"
},
"payment": {
"method": "BANK_SLIP",
"link": "http://localhost:3030/bankslip/882b8877-e65d-4e22-a5ac-5e0f22375c33/download",
"digitable_line": "30282023186900000000500000179044184750000016980",
"barcode": "30281847500000169802023169000000000000017904",
"expires_at": "2023-12-20 16:37:45"
},
"products": [
{
"id": "1bb763ee-4a35-416c-a577-eb1420234be1",
"name": "Mercado de Ações no Brasil",
"offer_id": "1643bb4a-15a1-4a3c-8a61-878a13538049",
"offer_name": "Mercado de Ações no Brasil",
"description": "Conheça os principais conceitos de renda variável e o funcionamento dos mercados",
"price": "R$ 119,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/c53ee207-b9ee-46f1-8671-9e7f3a4cd7ba/cover-1702928265568.jpg",
"is_order_bump": false
},
{
"id": "59f9c574-788b-44fa-81a8-45c81adeeba7",
"name": "Excel para Investidores",
"offer_id": "7c3cf544-0d35-478b-a816-909a949c5fb9",
"offer_name": "Excel para Investidores",
"description": "O melhor curso para quem quer começar a investir e ainda aprender a gerenciar sua carteira.",
"price": "R$ 49,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/cc59d5e5-73c3-41bc-8cf5-d14a0f137077/cover-1702928265568.jpg",
"is_order_bump": true
}
],
"utm": {
"src": "google",
"utm_source": "broadcast",
"utm_medium": "email",
"utm_campaign": "register",
"utm_term": "codes",
"utm_content": "link"
}
}
- Boleto expirado:
{
"event": "BANK_SLIP_EXPIRED",
"event_description": "Boleto expirado",
"checkout_id": "Q8J1N6K3",
"checkout_url": "http://localhost:3001/recovery/e0d5f16c-cdd0-4ec8-acdc-aec411510a5f",
"sale_id": "D2RP8RQ7",
"payment_method": "BANK_SLIP",
"total_price": "R$ 169,80",
"type": "ONE_TIME",
"status": "CANCELED",
"created_at": "2023-12-18 16:37:59",
"customer": {
"name": "João da Silva",
"document": "23875090127",
"email": "exemplo@email.com",
"phone_number": "5511987654321"
},
"payment": {
"method": "BANK_SLIP",
"link": "http://localhost:3030/bankslip/cc7a4fa0-fba1-4527-8793-077307c666a4/download",
"digitable_line": "30282023186900000000500000179044184750000016980",
"barcode": "30281847500000169802023169000000000000017904",
"expires_at": "2023-12-20 16:37:59"
},
"products": [
{
"id": "0a5e54b1-f91f-49b3-9a6e-699f9732040b",
"name": "Mercado de Ações no Brasil",
"offer_id": "3224dbb7-123d-463e-8e8c-041bfcbf6e12",
"offer_name": "Mercado de Ações no Brasil",
"description": "Conheça os principais conceitos de renda variável e o funcionamento dos mercados",
"price": "R$ 119,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/7e48c9be-43bc-4b89-810b-2df85c840c73/cover-1702928279737.jpg",
"is_order_bump": false
},
{
"id": "f6faaa5e-f659-4ba8-878f-39e5daa321d3",
"name": "Excel para Investidores",
"offer_id": "2004c7e3-7113-40f2-9ec4-46355bb2303b",
"offer_name": "Excel para Investidores",
"description": "O melhor curso para quem quer começar a investir e ainda aprender a gerenciar sua carteira.",
"price": "R$ 49,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/dc73f52f-7b3d-4e30-a98d-a4f53c05ce79/cover-1702928279737.jpg",
"is_order_bump": true
}
],
"utm": {
"src": "google",
"utm_source": "broadcast",
"utm_medium": "email",
"utm_campaign": "register",
"utm_term": "codes",
"utm_content": "link"
}
}
- PIX gerado:
{
"event": "PIX_GENERATED",
"event_description": "PIX gerado",
"checkout_id": "Q8J1N6K3",
"sale_id": "D2RP8RQ7",
"payment_method": "PIX",
"total_price": "R$ 169,80",
"type": "ONE_TIME",
"status": "PENDING",
"created_at": "2023-12-18 16:38:17",
"customer": {
"name": "João da Silva",
"document": "23875090127",
"email": "exemplo@email.com",
"phone_number": "5511987654321"
},
"payment": {
"method": "PIX",
"qrcode": "00020201011325br.gov.bcb.pixBADE53BA66C4121804702BR5823KIRVANO PAGAMENTOS LTDA***7213D5D7",
"qrcode_image": "http://localhost:3030/pix/a21e078e-2636-4a62-b35a-277e5818e9fa",
"expires_at": "2023-12-18 17:38:17"
},
"products": [
{
"id": "25d84393-3d74-409c-bff7-17b8ecac6bc7",
"name": "Mercado de Ações no Brasil",
"offer_id": "175ca45d-8701-4c58-b360-820831d7ee50",
"offer_name": "Mercado de Ações no Brasil",
"description": "Conheça os principais conceitos de renda variável e o funcionamento dos mercados",
"price": "R$ 119,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/070f0275-3e04-4d82-b064-3a294e0c9c33/cover-1702928297052.jpg",
"is_order_bump": false
},
{
"id": "ffd24c56-9cda-44b4-9b3c-3bb652afddec",
"name": "Excel para Investidores",
"offer_id": "bb9f48eb-c73c-4b08-b467-88c6b11b5b11",
"offer_name": "Excel para Investidores",
"description": "O melhor curso para quem quer começar a investir e ainda aprender a gerenciar sua carteira.",
"price": "R$ 49,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/452e8739-bc51-4895-bb7f-9b27e6b53654/cover-1702928297052.jpg",
"is_order_bump": true
}
],
"utm": {
"src": "google",
"utm_source": "broadcast",
"utm_medium": "email",
"utm_campaign": "register",
"utm_term": "codes",
"utm_content": "link"
}
}
- Pix expirado:
{
"event": "PIX_EXPIRED",
"event_description": "PIX expirado",
"checkout_id": "Q8J1N6K3",
"checkout_url": "http://localhost:3001/recovery/338bb957-30e1-4ad9-abf5-ecc72cb42171",
"sale_id": "D2RP8RQ7",
"payment_method": "PIX",
"total_price": "R$ 169,80",
"type": "ONE_TIME",
"status": "CANCELED",
"created_at": "2023-12-18 16:38:32",
"customer": {
"name": "João da Silva",
"document": "23875090127",
"email": "exemplo@email.com",
"phone_number": "5511987654321"
},
"payment": {
"method": "PIX",
"qrcode": "00020201011325br.gov.bcb.pixBADE53BA66C4121804702BR5823KIRVANO PAGAMENTOS LTDA***7213D5D7",
"qrcode_image": "http://localhost:3030/pix/7c9003c4-dc59-439e-837e-4a43aa05237f",
"expires_at": "2023-12-18 17:38:32"
},
"products": [
{
"id": "d9226c39-92f8-46de-8eff-f88fd1beba71",
"name": "Mercado de Ações no Brasil",
"offer_id": "424a8bae-12d5-49c6-8cae-f0ae8086fc41",
"offer_name": "Mercado de Ações no Brasil",
"description": "Conheça os principais conceitos de renda variável e o funcionamento dos mercados",
"price": "R$ 119,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/8eb8640a-2abc-439a-a41e-98a71ea2d6d5/cover-1702928312980.jpg",
"is_order_bump": false
},
{
"id": "29bb2aba-8192-4b6d-9671-890346272868",
"name": "Excel para Investidores",
"offer_id": "b9729b1d-2f86-40ec-b92b-6eeddab4f339",
"offer_name": "Excel para Investidores",
"description": "O melhor curso para quem quer começar a investir e ainda aprender a gerenciar sua carteira.",
"price": "R$ 49,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/c6cf21ea-2170-408c-814c-721b3a3e8646/cover-1702928312980.jpg",
"is_order_bump": true
}
],
"utm": {
"src": "google",
"utm_source": "broadcast",
"utm_medium": "email",
"utm_campaign": "register",
"utm_term": "codes",
"utm_content": "link"
}
}
- Compra recusada:
{
"event": "SALE_REFUSED",
"event_description": "Compra recusada",
"checkout_id": "Q8J1N6K3",
"checkout_url": "http://localhost:3001/recovery/f3d63649-4a4c-45d9-bbb1-0a89a29f386f",
"sale_id": "D2RP8RQ7",
"payment_method": "CREDIT_CARD",
"total_price": "R$ 169,80",
"type": "ONE_TIME",
"status": "REFUSED",
"created_at": "2023-12-18 16:39:52",
"customer": {
"name": "João da Silva",
"document": "23875090127",
"email": "exemplo@email.com",
"phone_number": "5511987654321"
},
"payment": {
"method": "CREDIT_CARD",
"brand": "visa",
"installments": 1
},
"products": [
{
"id": "fe6ef810-ad67-4d7c-afd5-f2c24ebf4009",
"name": "Mercado de Ações no Brasil",
"offer_id": "5c098a7d-00e1-45c5-881a-b0559112fb10",
"offer_name": "Mercado de Ações no Brasil",
"description": "Conheça os principais conceitos de renda variável e o funcionamento dos mercados",
"price": "R$ 119,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/4421b965-4040-49cc-8ad0-19d839fa01d1/cover-1702928392440.jpg",
"is_order_bump": false
},
{
"id": "038bc9e5-f42b-4e5a-bd9e-329614fce32b",
"name": "Excel para Investidores",
"offer_id": "f79d7b69-a551-4387-a5c0-6aec70388bd1",
"offer_name": "Excel para Investidores",
"description": "O melhor curso para quem quer começar a investir e ainda aprender a gerenciar sua carteira.",
"price": "R$ 49,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/e0c06bb9-15b2-4b21-9a0c-411fd0c7c369/cover-1702928392440.jpg",
"is_order_bump": true
}
],
"utm": {
"src": "google",
"utm_source": "broadcast",
"utm_medium": "email",
"utm_campaign": "register",
"utm_term": "codes",
"utm_content": "link"
}
}
- Chargeback:
{
"event": "SALE_CHARGEBACK",
"event_description": "Chargeback",
"checkout_id": "Q8J1N6K3",
"sale_id": "D2RP8RQ7",
"payment_method": "CREDIT_CARD",
"total_price": "R$ 169,80",
"type": "ONE_TIME",
"status": "CHARGEBACK",
"created_at": "2023-12-18 16:40:32",
"customer": {
"name": "João da Silva",
"document": "23875090127",
"email": "exemplo@email.com",
"phone_number": "5511987654321"
},
"payment": {
"method": "CREDIT_CARD",
"brand": "visa",
"installments": 1,
"finished_at": "2023-12-18 16:40:47"
},
"products": [
{
"id": "5ac480fd-ac4c-4db5-92d4-a2c9f669abb6",
"name": "Mercado de Ações no Brasil",
"offer_id": "d68a7f33-0f88-40cb-a8cd-2062b195bc7e",
"offer_name": "Mercado de Ações no Brasil",
"description": "Conheça os principais conceitos de renda variável e o funcionamento dos mercados",
"price": "R$ 119,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/c33243fd-928f-4d34-9800-fc2bcee47875/cover-1702928432592.jpg",
"is_order_bump": false
},
{
"id": "df091402-c74f-447a-9daa-e67af79be78c",
"name": "Excel para Investidores",
"offer_id": "98b5f24c-562a-4e3a-818f-6c9100b83d6d",
"offer_name": "Excel para Investidores",
"description": "O melhor curso para quem quer começar a investir e ainda aprender a gerenciar sua carteira.",
"price": "R$ 49,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/f8d40abc-acfb-4fb6-ab01-90198eb54bef/cover-1702928432592.jpg",
"is_order_bump": true
}
],
"utm": {
"src": "google",
"utm_source": "broadcast",
"utm_medium": "email",
"utm_campaign": "register",
"utm_term": "codes",
"utm_content": "link"
}
}
- Compra aprovada (Preço único):
{
"event": "SALE_APPROVED",
"event_description": "Compra aprovada",
"checkout_id": "Q8J1N6K3",
"sale_id": "D2RP8RQ7",
"payment_method": "CREDIT_CARD",
"total_price": "R$ 169,80",
"type": "ONE_TIME",
"status": "APPROVED",
"created_at": "2023-12-18 16:40:06",
"customer": {
"name": "João da Silva",
"document": "23875090127",
"email": "exemplo@email.com",
"phone_number": "5511987654321"
},
"payment": {
"method": "CREDIT_CARD",
"brand": "visa",
"installments": 1,
"finished_at": "2023-12-18 16:40:21"
},
"products": [
{
"id": "6c5708c9-7ae9-4ba3-aefc-c16029d4e729",
"name": "Mercado de Ações no Brasil",
"offer_id": "568de0c1-3d20-45c2-b273-b91be1f7bd58",
"offer_name": "Mercado de Ações no Brasil",
"description": "Conheça os principais conceitos de renda variável e o funcionamento dos mercados",
"price": "R$ 119,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/3e7feeb4-a4db-4454-9275-141244d82283/cover-1702928406873.jpg",
"is_order_bump": false
},
{
"id": "b1e74f14-6013-4981-a831-d7fc45fa5c10",
"name": "Excel para Investidores",
"offer_id": "5b80c3ef-8309-4e63-b8c7-3be3c438c115",
"offer_name": "Excel para Investidores",
"description": "O melhor curso para quem quer começar a investir e ainda aprender a gerenciar sua carteira.",
"price": "R$ 49,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/b22a2474-f275-4640-a71d-1d61ffda22d8/cover-1702928406873.jpg",
"is_order_bump": true
}
],
"utm": {
"src": "google",
"utm_source": "broadcast",
"utm_medium": "email",
"utm_campaign": "register",
"utm_term": "codes",
"utm_content": "link"
}
}
- Compra aprovada (Assinatura):
{
"event": "SALE_APPROVED",
"event_description": "Compra aprovada",
"checkout_id": "Q8J1N6K3",
"sale_id": "D2RP8RQ7",
"payment_method": "CREDIT_CARD",
"total_price": "R$ 169,80",
"type": "RECURRING",
"status": "APPROVED",
"created_at": "2023-12-18 16:40:06",
"customer": {
"name": "João da Silva",
"document": "23875090127",
"email": "exemplo@email.com",
"phone_number": "5511987654321"
},
"payment": {
"method": "CREDIT_CARD",
"brand": "visa",
"installments": 1,
"finished_at": "2023-12-18 16:40:21"
},
"plan": {
"name": "Plano Anual",
"charge_frequency": "ANNUALLY",
"next_charge_date": "2024-12-18 16:41:16"
},
"products": [
{
"id": "6c5708c9-7ae9-4ba3-aefc-c16029d4e729",
"name": "Mercado de Ações no Brasil",
"offer_id": "568de0c1-3d20-45c2-b273-b91be1f7bd58",
"offer_name": "Mercado de Ações no Brasil",
"description": "Conheça os principais conceitos de renda variável e o funcionamento dos mercados",
"price": "R$ 119,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/3e7feeb4-a4db-4454-9275-141244d82283/cover-1702928406873.jpg",
"is_order_bump": false
},
{
"id": "b1e74f14-6013-4981-a831-d7fc45fa5c10",
"name": "Excel para Investidores",
"offer_id": "5b80c3ef-8309-4e63-b8c7-3be3c438c115",
"offer_name": "Excel para Investidores",
"description": "O melhor curso para quem quer começar a investir e ainda aprender a gerenciar sua carteira.",
"price": "R$ 49,90",
"photo": "https://s3.amazonaws.com/develop.kirvano.com/products/b22a2474-f275-4640-a71d-1d61ffda22d8/cover-1702928406873.jpg",
"is_order_bump": true
}
],
"utm": {
"src": "google",
"utm_source": "broadcast",
"utm_medium": "email",
"utm_campaign": "register",
"utm_term": "codes",
"utm_content": "link"
}
}