Webhook - Integrando com Mailbiz

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

- Atualização de saldo de pontos: Permite manter a informação da quantidade de pontos que o consumidor possui dentro da Mailbiz. 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.

Não é possível realizar o disparo através da Webhooks no momento. A Mailbiz requer duas chamadas para realizar o disparo, mas o webhook realiza apenas uma.

Atualização de Saldo de Pontos

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

Nesse primeiro guia vamos:

- Criar um novo Campo na Mailbiz

- Configurar a URL de webhook

- Cadastrar Webhook na BonifiQ

Criar um novo Campo na Mailbiz

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

- Na Mailbiz, acesse uma lista existente ou crie uma nova

- Clique em Campos Personalizados

- Clique em "Criar novo campo"

- Preencha o formulário da forma que preferir e clique em Criar Campo Personalizado

Gerar um token de API na Mailbiz

- Na Mailbiz, clique em seu nome, no topo dirieto da tela e clique em Chaves de API

- Clique em Criar chave de API

- De um nome sugestivo e clique em Salvar chave de API

Anote esse valor para usar logo em seguida

Gerar URL de Webhook

Agora precisamos gerar a URL do webhook. O padrão é o seguinte:

https://mbiz.mailclick.me/api.php/Subscriber.Subscribe?APIKey=SUACHAVEDEAPI&Command=Subscriber.Subscribe&ResponseFormat=JSON&ListID=SEU_ID_DE_LISTA&EmailAddress={{Customer.Email}}&CustomFieldSEU_ID_DE_CAMPO_PERSONALIZADO={{EarnedPoints}}&IPAddress=123456789&UpdateIfExists=true

Você precisa alterar os campos em negrito dessa URL:

- SUACHAVEDEAPI: coloque a chave de API gerada na Etapa anterior

- SEU_ID_DE_LIST: o id da lista dentro da Mailbiz 

- SEU_ID_DE_CAMPO_PERSONALIZADO: Id o campo customizado criado na primeira etapa

Por exemplo, se os campos forem:

- SUACHAVEDEAPI = 123456

- SEU_ID_DE_LISTA = 19719

- SEU_ID_DE_CAMPO_PERSONALIZADO=34661

Então a URL ficará:

https://mbiz.mailclick.me/api.php/Subscriber.Subscribe?APIKey=123456&Command=Subscriber.Subscribe&ResponseFormat=JSON&ListID=19719&EmailAddress={{Customer.Email}}&CustomField34661={{EarnedPoints}}&IPAddress=123456789&UpdateIfExists=true

Além de informado os pontos ganhos (EarnedPoints), é possível utilizar outros campos, conforme documentação do webhook: https://bonifiq.freshdesk.com/a/solutions/articles/150000176634

Cadastrar Webhook na BonifiQ

- Na BonifiQ, acesse o menu "API"

- Clique em "+ Credencial de API" e escolha "Webhook"

- Configure da seguinte forma:

a) Marque ATIVADO

b) Nome: Escolha um nome adequado, como MailBiz

c) Em URL cole a URL gerada no etapa anterior

d) Em "Tópicos" escolha "Ponto Adicionado"

e) Em "E-mail técnico" informe seu e-mail 

f) Clique em SALVAR

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