As comunicações são as mensagens - seja SMS ou E-mail - que a BonifiQ envia aos consumidores. Ao configurar um webhook de comunicação, o endpoint começará a receber as informações relativas a essas comunicações.
Com isso, você pode disparar e-mail, SMS ou utilizar outro canal da sua ferramenta de disparos ou CRM.
Webhook - Comunicação: Pontos por compras
Esse tópico é acionado quando um consumidor completa o objetivo de compra.
{
"Uuid": "6d98ff46-3255-4e7f-92ec-69db40ed4a42",
"Timestamp": "2024-06-20T16:50:13.3951893Z",
"Topic": 3,
"TopicName": "Communication_EarnPurchasePoints",
"Payload": {
"EarnedPoints": 10,
"ObjectiveType": 0,
"Customer": {
"Email": "emailwebhook@teste.com.br",
"Id": null,
"Name": "Teste Rath",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- EarnedPoints: Pontos ganhos pelo objetivo
- ObjectiveType: Tipo do objetivo (Pontos por compras - 0)
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data.
Webhook - Comunicação: Pontos por aniversário
Esse tópico é acionado quando um consumidor completa o objetivo de aniversário. Ele pode receber pontos por concluir Objetivos
{
"Uuid": "00b59aef-d561-450c-a4df-265de6cef537",
"Timestamp": "2024-06-20T16:45:57.7236232Z",
"Topic": 4,
"TopicName": "Communication_EarnBirthdayPoints",
"Payload": {
"EarnedPoints": 10,
"ObjectiveType": 2,
"Customer": {
"Email": "emailteste@teste.com.br",
"Id": "123456789",
"Name": "Markus Teste",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}
- EarnedPoints: Pontos ganhos pelo objetivo
- ObjectiveType: Tipo do objetivo (Pontos por aniversário - 2)
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Pontos por cadastro
Esse tópico é acionado quando um consumidor completa o objetivo de cadastro.
{
"Uuid": "6d98ff46-3255-4e7f-92ec-69db40ed4a42",
"Timestamp": "2024-06-20T16:50:13.3951893Z",
"Topic": 5,
"TopicName": "Communication_EarnSignupPoints",
"Payload": {
"EarnedPoints": 10,
"ObjectiveType": 1,
"Customer": {
"Email": "emailwebhook@teste.com.br",
"Id": "864197462",
"Name": "Teste Rath",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32",
}
}
}
- EarnedPoints: Pontos ganhos pelo objetivo
- ObjectiveType: Tipo do objetivo (Pontos por cadastro - 1)
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Pontos por review
Esse tópico é acionado quando um consumidor completa o objetivo de review.
{
"Uuid": "263320de-6857-47e3-8faa-1dcc97494081",
"Timestamp": "2024-06-20T17:09:34.2987858Z",
"Topic": 6,
"TopicName": "Communication_EarnReviewPoints",
"Payload": {
"EarnedPoints": 10,
"ObjectiveType": 3,
"Customer": {
"Email": "emailteste@bonifiq.com.br",
"Id": "8762197462",
"Name": "Nome teste",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- EarnedPoints: Pontos ganhos pelo objetivo
- ObjectiveType: Tipo do objetivo (Pontos por review - 3)
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Pontos por indicar amigo
Esse tópico é acionado quando um consumidor completa o objetivo de indicação de amigo.
{
"Uuid": "508ebb4e-0e43-45c6-8811-0a715043c1f4",
"Timestamp": "2024-06-20T17:09:33.4979688Z",
"Topic": 7,
"TopicName": "Communication_ReferralCommunicationPoints",
"Payload": {
"FriendName": "Nome amigo",
"EarnedPoints": 10,
"ObjectiveType": 3,
"Customer": {
"Email": "emailteste@bonifiq.com.br",
"Id": "8762197462",
"Name": "Nome teste",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- EarnedPoints: Pontos ganhos pelo objetivo
- ObjectiveType: Tipo do objetivo (Pontos por indicar amigo - 2)
- FriendName: Nome do amigo indicado.
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Troca de pontos por recompensa
Esse tópico é acionado quando um consumidor resgata uma recompensa.
{
"Uuid": "1006539d-e7da-4a67-91b2-6a192a1f37c4",
"Timestamp": "2024-06-20T18:22:22.1679691Z",
"Topic": 8,
"TopicName": "Communication_RedeemPoints",
"Payload": {
"CouponCode": "couponCode547813",
"CouponDescription": "R$ 10,00",
"Points": 10,
"Customer": {
"Email": "RedeemPoints@teste.com",
"Id": "8762197462",
"Name": "Jena Frami",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- CouponCode: Código do cupom
- CouponDescription: Descrição informando o valor com descrição de fixo (R$) ou porcentagem (%)
- Points: Pontos gastos no resgate do cupom.
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Expiração de Pontos
Esse tópico é acionado quando a expiração de pontos e o lembrete de expiração estão habilitados.
{
"Uuid": "7f4204db-ad00-4a39-9c5b-48e5875837a3",
"Timestamp": "2024-06-20T18:39:31.6402157Z",
"Topic": 9,
"TopicName": "Communication_NotifyExpirablePoints",
"Payload": {
"PointsToExpire": 10,
"ExpirationAt": "2024-06-20T03:00:00Z",
"Customer": {
"Email": "teste@bonifiq.com.br",
"Id": "teste@bonifiq.com.br",
"Name": "Jena Frami",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- PointsToExpire: Pontos que estão próximos de expirar
- ExpirationAt: Data que ocorrerá a expiração
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Pontos disponíveis para uso
Esse tópico é acionado quando Lembrete de pontos para resgatar está habilitado, informando pontos para serem utilizados pelo consumidor
{
"Uuid": "aa5be3af-a173-4184-b38d-eb39f0c89dc5",
"Timestamp": "2024-06-20T18:49:55.7099277Z",
"Topic": 10,
"TopicName": "Communication_PointsToUse",
"Payload": {
"PointsToUse": 10,
"maxValueDiscount": "R$ 10,00",
"maxPercentDiscount": "20%",
"Customer": {
"Email": "teste@bonifiq.com.br",
"Id": "teste@bonifiq.com.br",
"Name": "Jena Frami",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- PointsToUse: Pontos disponivels para uso
- maxValueDiscount: Valor máximo para geração de desconto
- maxPercentDiscount: Valor máximo em porcentagem de geraçao de desconto
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Cupom disponível para uso
Esse tópico é acionado quando Lembrete de cupons para uso está habilitado, informando os dados do cupom para ser utilizado pelo consumidor
{
"Uuid": "b180a774-3b64-485d-97ca-a9eef4e5a043",
"Timestamp": "2024-06-20T19:10:48.499839Z",
"Topic": 11,
"TopicName": "Communication_CouponsToUse",
"Payload": {
"CouponType": 0,
"ValidDateEnd": "2024-07-02T17:12:11.396371",
"CouponValue": 3.714080191065451,
"CouponCode": "c52zknh3vb",
"Customer": {
"Email": "Mandy_OConner@teste.com",
"Id": "teste@bonifiq.com.br",
"Name": "Jena Frami",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- CouponType: 0 - FixedValue | 1 - Percent
- ValidDateEnd: Data de validade do cupom
- CouponValue: valor de desconto do cupom
- CouponCode: Código do cupom
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Troca de pontos por recompensa customizada
Esse tópico é acionado quando o consumidor realiza o resgate da recompensa customizada.
{
"Uuid": "c496cb1c-a4c4-4af5-9cf1-4795d7ec3720",
"Timestamp": "2024-06-21T12:43:19.6851307Z",
"Topic": 12,
"TopicName": "Communication_RewardCustomRedeemNotification",
"Payload": {
"Points": 10,
"RewardDescription": "Recompensa teste",
"Coupon": "CouponTesteeca8c08d",
"Customer": {
"Email": "Cory.Smith@teste.com",
"Id": "teste@bonifiq.com.br",
"Name": "Jena Frami",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- Points: Pontos utilizados pelo resgate da recompensa
- RewardDescription: Descrição da recompensa
- Coupon: Código do cupom
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Alteração de pontos do cliente
Esse tópico é acionado quando é realizado alteração nos pontos do consumidor via tela. Realizando remoção de pontos ou acréscimo de pontos.
{
"Uuid": "ad307986-3153-4b3f-bbdb-4db4ca20db51",
"Timestamp": "2024-06-21T14:05:22.319069Z",
"Topic": 13,
"TopicName": "Communication_CustomerPointChangeNotification",
"Payload": {
"Points": 100,
"PointsValidDate": "2024-06-21",
"Customer": {
"Email": "Billy.Paucek@teste.com",
"Id": "teste@bonifiq.com.br",
"Name": "Jena Frami",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- Points: Pontos removidos ou incrementados
- PointsValidDate: validade dos pontos
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Cliente subiu de nível
Esse tópico é acionado quando o consumidor sobe de nível, sendo através de alteração via tela ou conclusão de metas.
{
"Uuid": "1e1cca83-7b8c-4b29-a859-bd3e1b832400",
"Timestamp": "2024-06-21T14:12:52.2944665Z",
"Topic": 14,
"TopicName": "Communication_CustomerTierUpgradeNotification",
"Payload": {
"TierName": "UpNivel",
"Benefits": [
"Beneficios"
],
"NextTierTargets": [
"Proximos"
],
"Customer": {
"Email": "Moses.McClure62@gmail.com",
"Id": null,
"Name": "Ronaldo Fay",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- TierName: nome do nível que se encontra
- Benefits: lista de benefícios do nível
- NextTierTargets: lista de próximos níveis disponíveis
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Cliente desceu de nível
Esse tópico é acionado quando o consumidor desce de nível.
{
"Uuid": "1e1cca83-7b8c-4b29-a859-bd3e1b832400",
"Timestamp": "2024-06-21T14:12:52.2944665Z",
"Topic": 14,
"TopicName": "Communication_CustomerTierUpgradeNotification",
"Payload": {
"TierName": "DownNivel",
"Benefits": [
"Beneficios"
],
"NextTierTargets": [
"Proximos",
"next"
],
"Customer": {
"Email": "Moses.McClure62@gmail.com",
"Id": null,
"Name": "Ronaldo Fay",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- TierName: nome do nível que se encontra
- Benefits: lista de benefícios do nível
- NextTierTargets: lista de próximos níveis disponíveis
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Webhook - Comunicação: Enviar código de validação
Esse tópico é acionado quando é realizado o envio do código OTP para o consumidor.
{
"Uuid": "6e35b81d-8e5c-406d-9948-29007ff9cd7c",
"Timestamp": "2024-06-21T14:42:12.843182Z",
"Topic": 16,
"TopicName": "Communication_SentOTPToCustomer",
"Payload": {
"OTP": "123456",
"Customer": {
"Email": "Alfred_DAmore73@hotmail.com",
"Id": null,
"Name": "Peyton O'Reilly",
"Phone": "11987198778",
"BirthdayDate": "2024-08-30T14:34:32"
}
}
}- OTP: código de uso único gerado
- Customer: Dados do consumidor a que se referem os pontos. O Id nesse caso pode ser o da plataforma, o e-mail ou documento, dependendo da plataforma utilizada. O phone está no formato como está cadastrado na plataforma e pode variar. O campo BirthdayDate representa a data em formato ISO8601 e pode ser nulo, caso não exista cadastro dessa data
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo