Quando configuras um webhook na SalesPark, a plataforma pode enviar um pedido POST para o URL que definiste sempre que ocorrer um dos eventos selecionados.
Cada pedido inclui um payload em formato JSON com os dados relevantes do evento, como identificadores da compra, informações do comprador, produto associado e outros detalhes úteis para integração com sistemas externos.
Nesta página encontras exemplos de payload dos principais eventos disponíveis. Estes exemplos servem apenas para demonstrar a estrutura dos dados enviados e ajudar na implementação ou testes da integração.
⚠️ Os exemplos apresentados utilizam dados fictícios ou anonimizados (emails, telefones, IDs, etc.).
Exemplo de Payload do Evento: Pre-Checkout
Pre-Checkout - Ocorre quando inicia o processo de checkout (Após o preenchimento dos dados iniciais).
{
"body": {
"version": 14,
"event": "pre_checkout",
"date": "2026-03-08T15:43:37Z",
"formatted_date": {
"timezone": "Europe/Lisbon",
"date": "08-03-2026 15:43:37"
},
"formatted_alt_date": {
"timezone": "Europe/Lisbon",
"date": "2026-03-08 15:43:37"
},
"product_id": "PRD1AB2CD3EF4GH",
"product_name": "Produto de Exemplo",
"purchase_id": "PUR123ABC456XYZ",
"buyer_name": "Maria Silva",
"buyer_email": "[email protected]",
"buyer_phone": "910000000",
"buyer_country": "PT",
"buyer_region": "PT",
"buyer_vatid": "PT999999990",
"salespark_key": "example_salespark_key_123456789"
}
}
Exemplo de Payload do Evento: Pagamento Pendente
Ocorre quando o comprador já indicou o meio de pagamento e o mesmo está pendente de validação/pagamento.
{
"body": {
"version": 15,
"event": "payment_pending",
"date": "2026-03-08T16:18:07.000Z",
"order_date": "2026-03-08T16:18:07.000Z",
"formatted_date": {
"timezone": "Europe/Lisbon",
"order_date": "08-03-2026 16:18:07"
},
"formatted_alt_date": {
"timezone": "Europe/Lisbon",
"order_date": "2026-03-08 16:18:07"
},
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"offer_id": "offer1234",
"purchase_id": "PUR8F2K9D1Z6XQ3",
"payment_unique_id": "PUR8F2K9D1Z6XQ3.PRD8X4K2Z1Q7LMN.OFFER1234.1",
"buyer_name": "Maria Silva",
"buyer_first_name": "Maria",
"buyer_last_name": "Silva",
"buyer_email": "[email protected]",
"buyer_phone": "+351910000000",
"buyer_country": "PT",
"buyer_region": "PT",
"management": "internal",
"amount": 19.9,
"quantity": 1,
"order_amount": 19.9,
"parent_order": {
"total": 19.9,
"items": [
{
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"price": 19.9,
"quantity": 1,
"offer_id": "offer1234",
"type": "main"
}
]
},
"affiliate_id": null,
"utm": {
"source": "",
"medium": "",
"campaign": "",
"content": "",
"term": ""
},
"payment_method": "MB",
"mb_entity": "12345",
"mb_reference": "123456789",
"mb_reference_end_date": "2026-03-18",
"mb_reference_iso_end_date": "2026-03-18T23:59:59.999Z",
"mb_reference_formatted_end_date": {
"timezone": "Europe/Lisbon",
"end_date": "18-03-2026 23:59:59"
},
"mb_reference_formatted_alt_end_date": {
"timezone": "Europe/Lisbon",
"end_date": "2026-03-18 23:59:59"
},
"salespark_key": "example_salespark_key_123456789"
}
}
Exemplo de Payload do Evento: Pre-Checkout (Método de Pagamento Selecionado)
Ocorre quando o comprador seleciona o método de pagamento no checkout.
{
"body": {
"event": "pre_checkout_options",
"date": "2026-03-08T15:41:03.000Z",
"formatted_date": {
"timezone": "Europe/Lisbon",
"date": "08-03-2026 15:41:03"
},
"formatted_alt_date": {
"timezone": "Europe/Lisbon",
"date": "2026-03-08 15:41:03"
},
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"purchase_id": "PUR8F2K9D1Z6XQ3",
"buyer_name": "Maria Silva",
"buyer_first_name": "Maria",
"buyer_last_name": "Silva",
"buyer_email": "[email protected]",
"buyer_phone": "+351910000000",
"utm": {
"source": "",
"medium": "",
"campaign": "",
"content": "",
"term": ""
},
"geo": {
"country": "PT",
"region": "PT"
},
"offer_id": "offer1234",
"payment_method": "mb",
"order_bumps": [],
"coupon": null,
"purchase_products": [
{
"format": "course",
"price_method": "one_time",
"product_id": "PRD8X4K2Z1Q7LMN",
"offer_id": "offer1234",
"name": "Produto Digital de Exemplo",
"price": 19.9,
"full_price": 19.9,
"price_details": {
"price_wo_vat": 16.18,
"vat_value": 3.72,
"vat_tax": 23
},
"qty": 1,
"type": "main"
}
],
"salespark_key": "example_salespark_key_123456789"
}
}
Exemplo de Payload do Evento: Carrinho Abandonado
Ocorre 30 minutos após o Pre-Checkout, caso a compra não tenha sido aprovada durante esse período.
{
"body": {
"version": 15,
"event": "abandoned_cart",
"date": "2026-03-08T16:21:25.000Z",
"order_date": "2026-03-08T16:21:25.000Z",
"formatted_date": {
"timezone": "Europe/Lisbon",
"order_date": "08-03-2026 16:21:25"
},
"formatted_alt_date": {
"timezone": "Europe/Lisbon",
"order_date": "2026-03-08 16:21:25"
},
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"offer_id": "offer1234",
"purchase_id": "PUR7D2K9F1Z6XQ8",
"payment_unique_id": "PUR7D2K9F1Z6XQ8.PRD8X4K2Z1Q7LMN.OFFER1234.1",
"buyer_name": "Maria Silva",
"buyer_first_name": "Maria",
"buyer_last_name": "Silva",
"buyer_email": "[email protected]",
"buyer_phone": "+351910000000",
"buyer_country": "PT",
"buyer_region": "PT",
"management": "internal",
"amount": 19.9,
"quantity": 1,
"order_amount": 19.9,
"parent_order": {
"total": 19.9,
"items": [
{
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"price": 19.9,
"quantity": 1,
"offer_id": "offer1234",
"type": "main"
}
]
},
"affiliate_id": null,
"utm": {
"source": "",
"medium": "",
"campaign": "",
"content": "",
"term": ""
},
"payment_method": "MB",
"mb_entity": "12345",
"mb_reference": "123456789",
"mb_reference_end_date": "2026-03-18",
"mb_reference_iso_end_date": "2026-03-18T23:59:59.999Z",
"mb_reference_formatted_end_date": {
"timezone": "Europe/Lisbon",
"end_date": "18-03-2026 23:59:59"
},
"mb_reference_formatted_alt_end_date": {
"timezone": "Europe/Lisbon",
"end_date": "2026-03-18 23:59:59"
},
"salespark_key": "example_salespark_key_123456789"
}
}
Exemplo de Payload do Evento: Compra Aprovada
Ocorre quando o pagamento é aprovado/concluído.
{
"body": {
"version": 15,
"event": "purchase_approved",
"date": "2026-03-08T16:28:03.000Z",
"order_date": "2026-03-08T16:25:01.000Z",
"paid_date": "2026-03-08T16:28:03.000Z",
"formatted_date": {
"timezone": "Europe/Lisbon",
"order_date": "08-03-2026 16:25:01",
"paid_date": "08-03-2026 16:28:03"
},
"formatted_alt_date": {
"timezone": "Europe/Lisbon",
"order_date": "2026-03-08 16:25:01",
"paid_date": "2026-03-08 16:28:03"
},
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"offer_id": "offer1234",
"purchase_id": "PUR9F3K7D2X1QZ6",
"payment_unique_id": "PUR9F3K7D2X1QZ6.PRD8X4K2Z1Q7LMN.OFFER1234.1",
"buyer_name": "Maria Silva",
"buyer_first_name": "Maria",
"buyer_last_name": "Silva",
"buyer_email": "[email protected]",
"buyer_phone": "+351910000000",
"buyer_country": "PT",
"buyer_region": "PT",
"management": "internal",
"amount": 19.9,
"quantity": 1,
"order_amount": 19.9,
"parent_order": {
"total": 19.9,
"items": [
{
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"price": 19.9,
"quantity": 1,
"offer_id": "offer1234",
"type": "main"
}
]
},
"affiliate_id": null,
"utm": {
"source": "",
"medium": "",
"campaign": "",
"content": "",
"term": ""
},
"payment_method": "CREDITCARD",
"salespark_key": "example_salespark_key_123456789"
}
}
Exemplo de Payload do Evento: Compra Concluída
Ocorre após o período de garantia no qual o comprador deixa de poder solicitar reembolso e o valor da venda fica disponível para retirada de fundos.
{
"body": {
"version": 15,
"event": "purchase_completed",
"date": "2026-02-21T16:00:07.997Z",
"order_date": "2026-02-21T16:00:07.997Z",
"paid_date": "2026-02-21T16:30:07.997Z",
"formatted_date": {
"timezone": "Europe/Lisbon",
"end_date": "11-03-2026 16:30:07"
},
"formatted_alt_date": {
"timezone": "Europe/Lisbon",
"end_date": "2026-03-11 16:30:07"
},
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"offer_id": "offer1234",
"purchase_id": "PUR7F3K2D9Z1XQ6",
"payment_unique_id": "PUR7F3K2D9Z1XQ6.PRD8X4K2Z1Q7LMN.OFFER1234.1",
"buyer_name": "Maria Silva",
"buyer_email": "[email protected]",
"buyer_phone": "910000000",
"buyer_country": "PT",
"buyer_region": "PT",
"buyer_vatid": "PT999999990",
"management": "internal",
"utm": {
"source": "linkedin",
"medium": "banner",
"campaign": "campaign_example",
"content": "link",
"term": "keyword_example"
},
"amount": 199.9,
"payment_method": "MB",
"mb_entity": "12345",
"mb_reference": "123456789",
"expires_at_day": "2026-03-11T16:30:07.998Z",
"mb_reference_end_date": "2026-03-11",
"mb_reference_iso_end_date": "2026-03-11T16:30:07.998Z",
"salespark_key": "example_salespark_key_123456789"
}
}
Exemplo de Payload do Evento: Parcela Incobrável
_ Ocorre quando uma tentativa de cobrança de uma parcela ou pagamento recorrente falha e o valor não é cobrado._
{
"body": {
"version": 15,
"event": "installment_uncollectable",
"date": "2026-03-02T16:21:41.015Z",
"order_date": "2026-03-02T16:21:41.015Z",
"paid_date": "2026-03-02T16:36:41.015Z",
"formatted_date": {
"timezone": "Europe/Lisbon",
"end_date": "11-03-2026 16:36:41"
},
"formatted_alt_date": {
"timezone": "Europe/Lisbon",
"end_date": "2026-03-11 16:36:41"
},
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"offer_id": "offer1234",
"purchase_id": "PUR7F3K2D9Z1XQ6",
"payment_unique_id": "PUR7F3K2D9Z1XQ6.PRD8X4K2Z1Q7LMN.offer1234.1",
"buyer_name": "Maria Silva",
"buyer_first_name": "Maria",
"buyer_last_name": "Silva",
"buyer_email": "[email protected]",
"buyer_phone": "910000000",
"buyer_country": "PT",
"buyer_region": "PT",
"buyer_vatid": "PT999999990",
"management": "internal",
"amount": 199.9,
"order_amount": 199.9,
"parent_order": {
"total": 199.9,
"items": [
{
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"price": 199.9,
"quantity": 1,
"offer_id": "offer1234",
"type": "main"
}
]
},
"utm": {
"source": "twitter",
"medium": "banner",
"campaign": "campaign_example"
},
"installment_id": "inst_example123",
"n_installments": -1,
"installment_number": 4,
"next_installment_number": 4,
"n_installments_paid": 3,
"is_recurrence": true,
"next_action": "23-03-2026 16:36:41",
"next_action_date": "2026-03-23T16:36:41.015Z",
"installment_canceled": false,
"installment_completed": false,
"installment_refunded": false,
"installment_uncollectable": true,
"payment_method": "MB",
"mb_entity": "12345",
"mb_reference": "123456789",
"expires_at_day": "2026-03-11T16:36:41.015Z",
"mb_reference_end_date": "2026-03-11",
"mb_reference_iso_end_date": "2026-03-11T16:36:41.015Z",
"payment_url": "https://checkout.salespark.io/installments-payment/example_purchase_id",
"salespark_key": "example_salespark_key_123456789"
}
}
Exemplo de Payload do Evento: Registo em Curso Gratuito / Teaser
Ocorre quando um utilizador se regista num curso disponibilizado gratuitamente como teaser.
{
"body": {
"version": 15,
"event": "teaser_access",
"date": "2026-03-08T16:40:33Z",
"formatted_date": {
"timezone": "Europe/Lisbon",
"date": "08-03-2026 16:40:33"
},
"formatted_alt_date": {
"timezone": "Europe/Lisbon",
"date": "2026-03-08 16:40:33"
},
"product_id": "PRD8X4K2Z1Q7LMN",
"product_name": "Produto Digital de Exemplo",
"purchase_id": "PUR7F3K2D9Z1XQ6",
"buyer_name": "Maria Silva",
"buyer_email": "[email protected]",
"buyer_phone": "910000000",
"buyer_country": "PT",
"buyer_region": "PT",
"buyer_vatid": "PT999999990",
"salespark_key": "example_salespark_key_123456789"
}
}
