Webhooks do Checkout
Acesse a documentação completa em - Webhook - Checkout
Para realizar o acesso ao Painel de Configurações vá em Checkout → Ferramentas → Webhooks → +Novo Webhook
Definir o nome do webhook
Nome descritivo para identificar o webhook.
Informar a URL de destino
URL que receberá os eventos enviados pela plataforma.
Selecionar os produtos
Escolha os produtos que deverão disparar notificações para esse webhook.
Selecionar os eventos
Defina quais eventos serão enviados para a URL informada.
Configurar o token de segurança
Token utilizado para validação da origem das requisições.
Após a configuração, a plataforma passará a enviar automaticamente os eventos selecionados para a URL informada sempre que ocorrerem ações relacionadas aos produtos configurados.
Observações importantes
- Todos os valores monetários estão em centavos
- Datas seguem o padrão YYYY-MM-DD HH:MM:SS
- Campos podem retornar null quando não aplicável
Eventos de webhook
Abaixo estão listados os eventos disparados.
Eventos de pedido
order.canceled— Pedido canceladoorder.expired— Pedido expiradoorder.completed— Pedido concluído
Eventos de transação
transaction.approved— Pedido aprovadotransaction.failed— Pedido reprovadotransaction.refunded— Pedido Reembolsadotransaction.charged_back— Chargeback de pedidotransaction.pending_refund— Pedido com reembolso pendentetransaction.payment_cc_initiated— Pagamento com cartão de crédito iniciadotransaction.pix_generated— Pix geradotransaction.boleto_generated— Boleto gerado
Eventos de acesso
release.access— Liberar Acessorevoke.access— Revogar Acesso
Eventos de compra
abandoned— Abandono de carrinho
Segurança
A autenticação é realizada por meio de um token de segurança definido no momento da configuração do webhook, o qual deve ser validado pelo sistema receptor para garantir a integridade e a confiabilidade da comunicação.
Código de exemplo de cabeçalhos recebidos:
{
"headers": {
"x-signature": "{token}"
...
}
}
Estrutura dos webhooks
Estrutura do webhook
{
"webhookUrl": "https://hook.us2.make.com/",
"httpVerb": "post",
"proxy": null,
"tries": 3,
"requestTimeout": 3,
"cert": null,
"certPassphrase": null,
"sslKey": null,
"sslKeyPassphrase": null,
"backoffStrategyClass": "BackoffStrategy",
"signerClass": null,
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"x-signature": "{token}"
},
"verifySsl": true,
"throwExceptionOnFailure": false,
"queue": "queue",
"payload": {
...
},
"meta": [],
"tags": {
"event": "order.completed",
"relay": true
},
"uuid": "13ad0881-4756-402a-b3c3-3c10c9825f95",
"outputType": "JSON",
"response": null,
"errorType": null,
"errorMessage": null,
"transferStats": null,
"job": null,
"connection": null,
"delay": null,
"afterCommit": null,
"middleware": [],
"chained": [],
"chainConnection": null,
"chainQueue": null,
"chainCatchCallbacks": null
}
Webhook de carrinho abandonado
Este webhook é disparado sempre que um carrinho de compras é identificado como abandonado. Ele permite que sistemas integrados sejam notificados automaticamente para ações como recuperação de vendas, envio de comunicações ao cliente ou análises de comportamento.
Evento
abandoned
Payload
{
"company": {
"id": "7268299385367167832",
"name": "company",
"email": "company.test@email.com",
"phone": "+55 11999999999",
"document_type": "cnpj",
"document_number": "00000000000000",
"owner": {
"id": "7268299385346197469",
"name": "Lucas da Silva",
"email": "lucas@company.com",
"phone": "+5511999999999",
"document_type": "cpf",
"document_number": "00000000000"
}
},
"payload": {
"id": "712",
"object": "shopping_cart",
"event": "abandoned",
"created_at": "2026-01-07 18:17:08",
"data": {
"products": [
{
"product_id": "2931346b-a686-4816-8f64-b476a669ea01",
"product_name": "Produto 1",
"category": "oneoff",
"price": 100
}
],
"customer": {
"name": null,
"cpf": null,
"email": "cliente@example.com",
"phone": null
},
"checkout": {
"checkout_link": "https://checkout.thebank.com.br/pt-BR/7338938162967740000"
}
}
}
}
Webhook de acesso
Este webhook é disparado sempre que uma compra é aprovada ou cancelada. Ele é utilizado para gerenciar automaticamente o acesso do cliente à plataforma, permitindo a liberação do acesso em casos de aprovação e a remoção do acesso quando ocorre o cancelamento.
Eventos
- revoke.access
- release.access
Payload de exemplo
{
"company": {
"id": "7268299385367167832",
"name": "company",
"email": "company.test@email.com",
"phone": "+55 11999999999",
"document_type": "cnpj",
"document_number": "00000000000000",
"owner": {
"id": "7268299385346197469",
"name": "Lucas da Silva",
"email": "lucas@company.com",
"phone": "+5511999999999",
"document_type": "cpf",
"document_number": "00000000000"
}
},
"payload": {
"id": "7407682939998804964",
"object": "order",
"event": "release.access",
"data": {
"status": "paid",
"customer": {
"id": "7394310639977632991",
"name": "João da Silva",
"email": "joao@example.com",
"phone_country": null,
"phone": "+55 11999999999",
"document_type": "cpf",
"document_number": "00000000000"
},
"product": {
"id": "7338938162967740629",
"name": "Produto 1",
"price": 10000,
"quantity": 1,
"expires_in": "2026-01-08 18:32:19",
"reference_id": "2931346b-a686-4816-8f64-b476a669ea01",
"platform": {
"id": "7268292516695246618",
"name": "Company plataforma"
}
},
"order": {
"id": "7407682939998804964",
"total": 10000,
"transaction": {
"paid_at": "2026-01-08 18:32:19",
"payment_method": "credit_card",
"instalments": 1,
"currency": "BRL",
"value": 11196,
"status": "approved",
"credit_card": {
"instalments": 1,
"brand": "VISA",
"last_digit": "1234"
}
}
}
}
}
}
Webhook de Pedido
Este webhook é enviado sempre que ocorre uma operação relacionada a um pedido na plataforma. Ele é disparado automaticamente a cada evento associado ao ciclo de vida do pedido, permitindo que sistemas integrados acompanhem e processem alterações de status em tempo real.
Eventos
- order.canceled
- order.expired
- order.completed
Payload de exemplo
{
"company": {
"id": "7268299385367167832",
"name": "company",
"email": "company.test@email.com",
"phone": "+55 11999999999",
"document_type": "cnpj",
"document_number": "00000000000000",
"owner": {
"id": "7268299385346197469",
"name": "Lucas da Silva",
"email": "lucas@company.com",
"phone": "+5511999999999",
"document_type": "cpf",
"document_number": "00000000000"
}
},
"payload": {
"object": "order",
"event": "order.completed",
"created_at": "2026-01-07 15:08:42",
"data": {
"customer": {
"id": "7407269030890449654",
"name": "João da Silva",
"email": "joao@example.com",
"phone_country": null,
"phone": "+55 11999999999",
"document_type": "cpf",
"document_number": "00000000000"
},
"main_product": {
"id": 7338938162967740000,
"title": "Produto 1",
"price": 10000
},
"order_bump": [
{
"product_id": 7338938162967740000,
"title": "Produto 1",
"price": 10000,
"order_bump": true
}
],
"transactions": [
{
"payment_method": "credit_card",
"instalments": 1,
"currency": "BRL",
"value": 11400,
"status": "approved",
"credit_card": {
"instalments": 1,
"brand": "VISA",
"last_digit": "1234"
}
}
],
"utms": []
}
}
}
Webhook de Transação
Este webhook é enviado sempre que ocorre uma transação relacionada ao pagamento de um pedido. Ele é disparado tanto para eventos de pagamento concluído quanto para a geração de meios de pagamento, como QR Code de Pix e boleto, permitindo o acompanhamento completo do fluxo de pagamento.
Eventos
- transaction.approved
- transaction.failed
- transaction.refunded
- transaction.charged_back
- transaction.pending_refund
- transaction.payment_cc_initiated
- transaction.pix_generated
- transaction.boleto_generated
Payload (produto com assinatura)
{
"object": "transaction",
"event": "transaction.approved",
"created_at": "2026-01-03 08:00:13",
"data": {
"id": 7405759151497423000,
"paid_at": "2026-01-03T11:00:13+00:00",
"status": "approved",
"transaction": {
"currency": "brl",
"amount": 12333,
"buyer_fees": 0,
"total_amount": 12333,
"cupom": ""
},
"payment_details": {
"payment_method": "credit_card",
"credit_card": {
"instalments": 1,
"brand": "discover",
"last_digit": 1234
}
},
"comissions": [],
"order": null,
"subscription": {
"code": "SB1B4H1HJ",
"periodicity": "monthly",
"periodicity_interval": 1,
"price": 12333,
"status": "active",
"started_at": "2025-12-02 20:02:23",
"next_billing_at": "2026-02-02 20:02:23",
"suspended_at": null,
"canceled_at": null,
"created_at": "2025-12-02 20:02:23",
"subscriber": {
"id": "7394310639977632991",
"name": "João da Silva",
"email": "joao@example.com",
"phone_country": null,
"phone": "+55 11999999999",
"document_type": "cpf",
"document_number": "00000000000"
},
"product": {
"id": 7394309835643586000,
"title": "Produto de assinatura",
"price": 12333
},
"invoice": {
"code": "SBIN1B4H1M1",
"attempts": 2,
"status": "paid",
"paid_at": "2026-01-03 11:00:13",
"refunded_at": null,
"charged_back_at": null,
"billing_date": "2026-01-02 20:02:23",
"created_at": "2026-01-03 11:00:09"
},
"transactions": [
{
"paid_at": "2026-01-03T11:00:13+00:00",
"payment_method": "credit_card",
"instalments": 1,
"currency": "BRL",
"value": 12333,
"status": "approved",
"credit_card": {
"instalments": 1,
"brand": "discover",
"last_digit": 1234
}
},
{
"paid_at": "2026-01-03T11:00:13+00:00",
"payment_method": "credit_card",
"instalments": 1,
"currency": "BRL",
"value": 12333,
"status": "approved",
"credit_card": {
"instalments": 1,
"brand": "discover",
"last_digit": 1234
}
}
]
}
}
}
|
Payload (produto de venda única)
{
"company": {
"id": "7268299385367167832",
"name": "company",
"email": "company.test@email.com",
"phone": "+55 11999999999",
"document_type": "cnpj",
"document_number": "00000000000000",
"owner": {
"id": "7268299385346197469",
"name": "Lucas da Silva",
"email": "lucas@company.com",
"phone": "+5511999999999",
"document_type": "cpf",
"document_number": "00000000000"
}
},
"payload": {
"object": "transaction",
"event": "transaction.approved",
"created_at": "2026-01-02 16:48:57",
"data": {
"id": 7405530052968814000,
"paid_at": "2026-01-02T19:48:57+00:00",
"status": "approved",
"transaction": {
"currency": "brl",
"amount": 10260,
"buyer_fees": 0,
"total_amount": 10260,
"cupom": ""
},
"payment_details": {
"payment_method": "credit_card",
"credit_card": {
"instalments": 1,
"brand": "mastercard",
"last_digit": 7600
}
},
"comissions": [],
"order": {
"id": 7405530048429536000,
"customer": {
"id": "7394310639977632991",
"name": "João da Silva",
"email": "joao@example.com",
"phone_country": null,
"phone": "+55 11999999999",
"document_type": "cpf",
"document_number": "00000000000"
},
"main_product": {
"id": 7338938162967740000,
"title": "Produto 1",
"price": 10000
},
"order_bump": [
{
"product_id": 7338938162967740000,
"title": "Produto 1",
"price": 10000,
"order_bump": true
}
],
"utms": []
},
"subscription": null
}
}
}
Atualizado em: 26/01/2026