Webhook - Integrando com Dinamize

Criada por Alex Camargo, Modificado em Sex, 16 Ago na (o) 3:25 PM por Alex Camargo

É possível fazer dois tipos de integração entre os webhooks da BonifiQ e a Dinamize:


- Atualização de saldo de pontos: Permite manter a informação da quantidade de pontos que o consumidor possui dentro da Dinamize. Com isso, você pode sempre encaminhar o saldo disponível para uso, em todas as comunicações da loja. Aqui utilizamos os webhook de Pontos.


- Incluir em régua de disparos: Normalmente a BonifiQ envia os e-mails aos seus consumidores (como os de notificação de pontos). Você pode, no entanto, utilizar a Dinamize para esse trabalho. Nesse caso, são utilizados os Webhook de Comunicação



Atualização de Saldo de Pontos

Nesse guia nós vamos atualizar o saldo de pontos na Dinamize sempre que um consumidor ganha ou usa seus pontos

Nesse primeiro guia vamos:

- Criar um novo Campo na Dinamize

- Gerar e configurar um Webhook na Dinamize

- Cadastrar esse Webhook na BonifiQ


Criar um novo Campo na Dinamize

Esse campo irá armazenar o saldo de ponto de cada consumidor. Para isso:

- Na Dinamize, acesse Contatos > Lista.

- Na lista desejada clique em Configurações

- Clique em "Campos da Lista" e depois "Adicionar Campo"

- Informe o Título desejado (por ex: "Saldo de Pontos"), em "Tipo" escolha "Numérico" e clique em Salvar 


Se você deseja armazenar o valor do Cashback, utilize o Tipo "Decimal"



Gerar e configurar um Webhook na Dinamize

- Na Dinamize, acesse "Canais">"Webhooks"

- Na lista desejada, clique em "+"

- Em "Nome" utilize um nome bem sugestivo e claro, por ex: Atualizar Saldo Pontos BonifiQ

- Em "Situação" marque "Ativo"

- Em "Sistema" escolha "Personalizado"

- No campo do lado direito, copie e cole o código:

{
   "Uuid":"4834c95e-84f7-485e-90de-09353df57fd3",
   "Timestamp":"2024-03-01T13:16:11.396371",
   "Topic":0,
   "TopicName":"Point_Add",
   "Payload":{
      "Points":200,
      "PointType":0,
      "PointAction":1,
      "Customer":{
         "Email":"melissa.murta+basenivel@bonifiq.com.br",
         "Id":"152740926",
         "Name":"Teste Nivel Base"
      },
      "PointsBalance":{
         "PointsBalance":300,
         "CashbackBalance":210
      },
      "PointId":4740
   }
}
Esse código está descrito e explicado no link: https://suporte.bonifiq.com.br/support/solutions/articles/150000176634-webhook-adicionar-pontos


- Clique em "Próximo Passo"

- Faça o mapeamento dos campos. Os únicos que precisam ser mapeados são:

- Payload.Customer.Email -> E-mail

- Payload.PointsBalance.PointsBalance -> Saldo de pontos

Se deseja utilizar Cashback, então utilize o campo Payload.PointsBalance.CashbackBalance

- Você pode deixar os demais campos como "Ignorar este campo"

- Clique em "Próximo Passo"

- Se desejar, inclua marcadores e clique em Enviar

- Ainda nessa tela, clique em "Copiar" próximo a URL do webhook, Nós vamos utilizar esse campo mais tarde



Cadastrar Webhook na BonifiQ

- Acesse sua conta da BonifiQ e vá em "API"

- No topo superior direito clique em "+ CREDENCIAL API"

- Escolha a opção "Webhook"

- Marque a opção de Ativo e informe um nome 

- em "URL" cole o endereço que foi copiado da Dinamize

- Em "Tópicos" escolha "Ponto Adicionado", "Ponto Removido" e "Ponto atualizad"

- Em "e-mail técnico" informe o endereço de e-mail que será notificado em caso de falha do webhook

- Clique em Salvar

E pronto! Agora quando um consumidor receber ou usar pontos o seu cadastro na Dinamize será atualizado.

Você pode testar esse fluxo alterando os pontos manualmente na BonifiQ e confirmando que o saldo foi atualizado na Dinamize



Incluir em régua de disparos

Outra forma de integrar a BonifiQ com a Dinamize é permitir que as comunicações da BonifiQ estejam dentro dos fluxos da Dinamize.

Para realizar essa integração precisamos seguir os passos:

- Criar um Webhook na Dinamize

- Cadastrar esse Webhook na BonifiQ

- Criar o fluxo de disparo na Dinamize


Gerar e configurar um Webhook na Dinamize

- Na Dinamize, acesse "Canais">"Webhooks"

- Na lista desejada, clique em "+"

- Em "Nome" utilize um nome bem sugestivo e claro, por ex: Notificar Pontos de Aniversário

- Em "Situação" marque "Ativo"

- Em "Sistema" escolha "Personalizado"

- No campo do lado direito, copie e cole o código:

{
  "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"
    }
  }
 }
 
Para saber os campos disponíveis em todas as comunicações acesse: https://suporte.bonifiq.com.br/support/solutions/articles/150000185928-webhook-comunicac%C3%B5es


- Clique em "Próximo passo" e faça o mapeamento dos campos que desejar. Você deve mapear ao menos o e-mail.

- Clique em "Próximo passo" e crie um novo marcador, utilizando um nome sugestivo (por ex: "Comunicação Pontos Aniversário BonifiQ"

- Clique em "Enviar"

- Ainda nessa tela, clique em "Copiar" próximo a URL do webhook, Nós vamos utilizar esse campo mais tarde



Cadastrar esse Webhook na BonifiQ

- Acesse sua conta da BonifiQ e vá em "API"

- No topo superior direito clique em "+ CREDENCIAL API"

- Escolha a opção "Webhook"

- Marque a opção de Ativo e informe um nome 

- em "URL" cole o endereço que foi copiado da Dinamize

- Em "Tópicos" escolha "Comunicação: Pontos por aniversário"

- Em "e-mail técnico" informe o endereço de e-mail que será notificado em caso de falha do webhook

- Clique em Salvar


Criar o fluxo de disparo na Dinamize

Agora, para realizar o disparo pela Dinamize, você pode fazer o seguinte:

- Fluxos > Criar do Zero

- Em "Gatilho" escolha "Conversão"

- Escolha "Webhooks"

- Marque a opção "Um webhook específico" e escolha o Webhook criado anteriormente

Agora basta configurar a automação da Dinamize, utilizando o gatilho criado na etapa anter


Este artigo foi útil?

Que bom!

Obrigado pelo seu feedback

Desculpe! Não conseguimos ajudar você

Obrigado pelo seu feedback

Deixe-nos saber como podemos melhorar este artigo!

Selecione pelo menos um dos motivos

Feedback enviado

Agradecemos seu esforço e tentaremos corrigir o artigo