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": "[email protected]",
    "phone": "[phone]",
    "document_type": "cnpj",
    "document_number": "00000000000000",
    "owner": {
      "id": "7268299385346197469",
      "name": "Lucas da Silva",
      "email": "[email protected]",
      "phone": "[phone]",
      "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": "[email protected]",
        "phone": null
      },
      "checkout": {
        "checkout_link": "https://checkout.thebank.com.br/pt-BR/7338938162967740000"
      }
    }
  }
}

Detalhes

company

Dados da empresa.

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Id da empresa
name	string	Sim	Nome da empresa
email	string	Sim	E-mail de contato da empresa
phone	string | null	Não	Telefone de contato
document_type	string	Sim	Tipo de documento ( cpf ou cnpj )
document_number	string	Sim	Número do documento da empresa
owner	object	Sim	Dados do proprietário

company.owner

Dados do responsável legal da empresa.

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Id do proprietário
name	string	Sim	Nome completo
email	string	Sim	E-mail de contato
phone	string | null	Não	Telefone
document_type	string	Sim	Tipo de documento ( cpf ou cnpj )
document_number	string	Sim	Número do documento

payload

Informações principais do evento de carrinho abandonado.

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Id do utm
object	string	Sim	Tipo do objeto relacionado ao evento. Ex: shopping_cart
event	string	Sim	Evento disparado. ( abandoned )
created_at	string (datetime)	Sim	Data e hora em que o evento foi gerado
data	object	Sim	Dados específicos do carrinho abandonado.

payload.data

Dados específicos do carrinho abandonado.

Campo	Tipo	Obrigatório	Descrição
products	object	Sim	Lista de produtos presentes no carrinho.
customer	object	Sim	Dados do cliente (quando disponíveis).
checkout	object	Sim	Informações de acesso ao checkout.

payload.data.products

Lista de produtos presentes no carrinho.

Campo	Tipo	Obrigatório	Descrição
product_id	string	Sim	Identificador do produto
product_name	string	Sim	Nome do produto
category	string	Sim	Categoria do produto ( oneoff , subscription , etc.)
price	number	Sim	Valor do produto (em centavos)

payload.data.customer

Dados do cliente (quando disponíveis).

Campo	Tipo	Obrigatório	Descrição
name	string	Não	Nome do cliente
cpf	string	Não	CPF do cliente
email	string	Não	E-mail informado no checkout
phone	string	Não	Telefone do cliente

Alguns campos podem ser null caso o cliente não tenha finalizado o preenchimento dos dados no checkout.

payload.data.checkout

Informações de acesso ao checkout.

Campo	Tipo	Obrigatório	Descrição
checkout_link	string (URL)	Sim	Link do checkout associado ao carrinho abandonado