🔚Eventos v.1.0.0

DESCONTINUADO

A v1.0.0 foi descontinuado.

Recomendamos migrar para a versão 2.0.0

Eventos

Carrinho Abandonado

Disparado quando um usuário acessa a página do checkout e preenche as informações de email ou telefone e não efetua a compra no período de 20 minutos.

{
	"type": "AbandonedCheckout",
	"event": {
		"productId": "9876541234",
		"productName": "Desafio de 30 Dias",
		"offerId": "1234563400",
		"groupId": "1234563400",
		"offerName": "Desafio de 30 Dias",
		"groupName": "Desafio de 30 Dias",
		"userEmail": "nome@seumail.com.br",
		"userPhone": "+55 11 90000 1234",
		"cause": "abandoned_checkout",
		"idempotencyKey": "qweasdzxcasdsqwe",
		"purchaseTiming": "2023-05-03T18:48:10.514Z",
		"sellerId": "12345-11111",
		"createdAt": "2023-05-03T18:38:19.723Z"
	},
	"version": "1.0.0"
}
Venda pendente

Disparado sempre que uma nova fatura é criada, mas ainda não foi paga.

{
	"type": "PendingSale",
	"event": {
		"userId": "01GcniNRKgO122q0zrgi2Tbu7QB3",
		"userName": "Nome Sobrenome",
		"userEmail": "nome@seumail.com.br",
		"userPhone": "+55 11 90000 1234",
		"totalAmount": 50,
		"groupId": "123456-3400",
		"groupName": "Desafio de 30 Dias",
		"recurring": "subscription",
		"paymentMethod": "credit_card",
		"affiliates": [
			{
				"affiliateAmount": 5,
				"affiliateId": "12345-0000",
				"affiliateName": "Nome do Afiliado"
			},
			{
				"affiliateAmount": 5,
				"affiliateId": "12345-0000",
				"affiliateName": "Nome do Afiliado"
			}
		],
		"discount": 10,
		"isRenewing": false,
		"sellerId": "12345-11111",
		"createdAt": "2023-05-03T18:38:19.723Z",
		"transactionId": "1E02RqBAk2ERQeXXDGO6",
		"userDocument": "051.713.580-95"
	},
	"version": "1.0.0"
}
Nova venda

Disparado sempre que uma fatura pendente é paga.

{
	"type": "NewSale",
	"event": {
		"userId": "01GcniNRKgO122q0zrgi2Tbu7QB3",
		"userName": "Nome Sobrenome",
		"userEmail": "nome@seumail.com.br",
		"userPhone": "+55 11 90000 1234",
		"totalAmount": 50,
		"groupId": "123456-3400",
		"groupName": "Desafio de 30 Dias",
		"recurring": "subscription",
		"paymentMethod": "credit_card",
		"affiliates": [
			{
				"affiliateAmount": 5,
				"affiliateId": "12345-0000",
				"affiliateName": "Nome do Afiliado"
			},
			{
				"affiliateAmount": 5,
				"affiliateId": "12345-0000",
				"affiliateName": "Nome do Afiliado"
			}
		],
		"discount": 10,
		"isRenewing": false,
		"sellerId": "12345-11111",
		"createdAt": "2023-05-03T18:38:19.723Z",
		"transactionId": "1E02RqBAk2ERQeXXDGO6",
		"userDocument": "051.713.580-95"
	},
	"version": "1.0.0"
}
Novo usuário

Disparado quando um usuário faz uma compra pela primeira vez com um determinado criador (independente de qual grupo ou data, se o usuário já tiver comprado um grupo desse criador, o evento não será disparado).

{
	"type": "NewUser",
	"event": {
		"userId": "01GcniNRKgO122q0zrgi2Tbu7QB3",
		"userName": "Nome Sobrenome",
		"userEmail": "nome@seumail.com.br",
		"userPhone": "+55 11 90000 1234",
		"groupId": "123456-3400",
		"amount": 50,
		"sellerId": "12345-11111",
		"userDocument": "051.713.580-95",
		"groupName": "Desafio de 30 Dias"
	},
	"version": "1.0.0"
}
Assinatura cancelada

Disparado sempre que uma assinatura é cancelada, seja por finalizado seus dias assinados ou porque o usuário cancelou sua renovação.

Solicitação de reembolso

Disparado quando uma solicitação de reembolso é criada.

Venda em protesto

Disparado quando uma fatura entra em protesto, ou seja, o cliente contestou essa fatura através da bandeira do cartão de crédito.

Venda cancelada

Disparado sempre que uma fatura é cancelada, seja por motivo de contestação, reembolso, etc.

Propriedades

Os eventos seguem um padrão de payload e propriedades, sendo elas:

type string

Tipo do evento de Webhook

Valores possíveis
Descrição

AbandonedCheckout

Carrinho abadonado

PendingSale

Venda Pendente

NewSale

Nova Venda

NewUser

Novo Usuário

InProtestSale

Em Protesto

RefundRequested

Solicitação de Reembolso

CanceledSubscription

Assinatura Cancelada

CanceledSale

Venda Cancelada

event.recurring string

Tipo de assinatura

Valores possíveis
Descrição

subscription

Assinatura

one_time_purchased

Pagamento único

event.paymentMethod string

descrição

Valores possíveis
Descrição

credit_card

Cartão de Crédito

pix

Pix

bank_slip

Boleto

event.reason string

descrição

Valores possíveis
Descrição

renewed

Renovação

upgraded

Upgrade de Plano

expired

Expirado

canceled

Cancelado

refunded

Reembolsado

in_protest

Em Protesto

chargeback

Chargeback

refused

Recusado

AnteriorSolicitação de ReembolsoPróximoBoas práticas

Atualizado

Isto foi útil?