GoatCom - Documentação API
  1. Webhooks
GoatCom - Documentação API
  • Webhooks
    • Exemplo de Webhook Recebido
  1. Webhooks

Exemplo de Webhook Recebido

Eventos de webhook#

Os eventos serão enviados via requisição POST para a URL previamente cadastrada no painel.
As requisições incluirão o cabeçalho no seguinte formato:
headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Bearer {TOKEN_FORNECIDO}',
    'User-Agent': 'Goat-Webhook/1.0'
}
No painel do sistema, você poderá cadastrar e gerenciar os webhooks de forma simples.
Abaixo, apresentamos uma imagem ilustrativa da tela de configuração, onde é possível definir:
URL de destino: endereço que receberá as notificações via POST.
Token de autenticação: utilizado no header para validação das requisições.
Essa configuração garante que o seu sistema esteja apto a receber os eventos enviados pela nossa plataforma.
image.png

Exemplo webhook de compras#

Retorno (event_type) nos casos de:
Pedido criado (ORDER_CREATED)
Pedido aprovado (ORDER_APPROVED)
Pedido recusado (ORDER_REJECTED)
Atualização do pedido (ORDER_UPDATE)
Opções de status
STATUS = [
    ('PENDING'),
    ('PAID'),
    ('ORDER_AUTHORIZED'),
    ('INVOICED'),
    ('PRODUCTS_BEING_SORTED'),
    ('READY_FOR_SHIPMENT'),
    ('IN_TRANSIT'),
    ('DELIVERED'),
    ('FAILED'),
    ('CANCELED'),
]
Resposta
{
    "id": 493,
    "cart": {
        "id": 11569,
        "origin": "VIRTUAL_STORE",
        "total_price": 1399.9,
        "subtotal": 1.4,
        "total_discount": 1398.5,
        "shipping_price": 0.0,
        "products": [
            {
                "id": 1076,
                "quantity": 2.0,
                "title": "SNKOWBOARD",
                "variant": {
                    "id": 21,
                    "title": "Ice / P",
                    "sku": null,
                    "price": 699.95,
                    "cost_price": null,
                    "image": {
                        "id": 35,
                        "image": "https://goatcom.io/media/imagens/8322719285419"
                    }
                }
            }
        ],
        "customer": {
            "name": "Nome do Cliente",
            "email": "email@exemplo.com",
            "phone": "1234567890"
        }
    },
    "status": "PAID",
    "event_type": "ORDER_UPDATE",
    "shipping": {
        "id": 354,
        "shipping_price": 0.0,
        "shipping_label": "Frete Gratis",
        "delivery_time": "2025-06-14T18:25:41",
        "zipcode": "25970568",
        "address": "Servidão Primavera",
        "number": "84",
        "neighborhood": "Caleme",
        "city": "Teresópolis",
        "uf": "RJ"
    },
    "payment_date": "2025-06-13T00:00:00",
    "payment_method": "pix",
    "pix_qr_code": "https://api.tryplopay.com/invoices/qrcode/123",
    "pix_code": "00020101021226880014BR.GOV.BCB.PIX2566qrcodespix.sejaefi.com.br/v2/cobv/31233131231231***63046CE6",
    "bank_slip_url": null,
    "bank_slip_code": null,
    "total_price": 80.0,
    "link_recovery": "https://app.goatcom.io/checkout/bYrazJhCkxkUWhOSl7wln4gK9ghYSp_IjRw_8U",
    "created_at": "2025-06-13T18:25:41"
}

Exemplo webhook de carrinho abandonado#

Retorno (event_type)
Carrinho abandonado (CART_ABANDONED)
No caso de um carrinho abandonado, como ainda não houve transação, não existirão dados de pagamento.
A estrutura interna de cart permanecerá a mesma; entretanto, externamente serão enviados apenas os campos event_type e link_recovery.
Resposta
{
    "cart": {
        "id": 11569,
        "origin": "VIRTUAL_STORE",
        "total_price": 1399.9,
        "subtotal": 1.4,
        "total_discount": 1398.5,
        "shipping_price": 0.0,
        "products": [
            {
                "id": 1076,
                "quantity": 2.0,
                "title": "SNKOWBOARD",
                "variant": {
                    "id": 21,
                    "title": "Ice / P",
                    "sku": null,
                    "price": 699.95,
                    "cost_price": null,
                    "image": {
                        "id": 35,
                        "image": "https://goatcom.io/media/imagens/8322719285419"
                    }
                }
            }
        ],
        "customer": {
            "name": "Nome do Cliente",
            "email": "email@exemplo.com",
            "phone": "1234567890"
        }
    },
    "event_type": "CART_ABANDONED",
    "link_recovery": "https://dev.app.goatcom.io/checkout/KEQ-gR3Afthbr0HBu684TAH8GBaKVUJ-MxfJ-wce1Xw"
}
Built with