Objetivo da integração: Cada vez que um usuário der ou revogar consentimento na plataforma da PrivacyTools isso deve se refletir no Mailchimp.
O Mailchimp utiliza “tags” para segmentar os usuários. Logo, vamos considerar que a existência de uma tag significa que o usuário possui consentimento e a remoção da tag significa que não possui consentimento.
Documentação oficial de API’s do Mailchimp:
Premissas para integração
Você possui uma conta criada no Mailchimp
Você possui uma conta criada na Privacy Tools
Você criou uma finalidade no recurso de finalidades de consentimento e copiou o hash da finalidade.
Passo 1 - Criando uma chave de integração no Mailchimp
Na página de configuração da sua conta acesse o menu “API keys” conforme imagem abaixo.
Clique no botão “Create a key”. Ao final a sua chave aparecerá na coluna conforme abaixo. Copie essa chave e guarde em segurança.
Passo 2 - Configurando o webhook
Agora vamos configurar o webhook na Privacy Tools para notificar o Mailchimp sempre que um consentimento de alguém mudar.
Gestão de tags no mailchimp:
https://mailchimp.com/developer/marketing/api/list-member-tags/add-or-remove-member-tags/
Observação importante: O Mailchimp possui diversos datacenters e a URL do endpoint muda de acordo com o datacenter. Nos exemplos abaixo o datacenter é o “us7”. Confira na URL da sua conta no Mailchimp qual o seu datacenter.
2.1 - Crie um webhook com os seguintes valores:
Método - POST
Endpoint - https://us7.api.mailchimp.com/3.0/lists/{listID}/members/${emailMd5}/tags
Usuário - anystring
Senha - A sua API key copiada no passo anterior
O {listID} que compõe o endpoint você precisa obter no Mailchimp conforme a sua configuração de listas. Caso queira obter os códigos faça o comando abaixo.
curl -X GET 'https://us7.api.mailchimp.com/3.0/lists' --user 'anystring:A_SUA_CHAVE_DE_API'
Caso queira obter a lista de audiência pelo admin do Mailchimp acesse o menu “Audience dashboard >> Manage Audience >> Settings” e copie o valor do campo “Unique ID for the audience”
Corpo da requisição:
{ "tags": [ { "name": "newsletter", "status": "active" } ], "is_syncing": false }
Coloque “active” se você quiser ativar o consentimento na tag “newsletter”. Caso queira revogar o consentimento mude para “inactive” . O nome da tag é ilustrativo, você pode usar uma ou várias tags conforme a sua preferência e configuração no Mailchimp.
Salve o webhook.
2.2 - Crie uma trigger para disparar o webhook
Com o webhook criado agora vamos configurar uma trigger para executar o webhook quando acontecer algum evento. Acesse o menu “Minhas triggers” e crie uma nova conforme o exemplo abaixo. Nesse caso é uma trigger que vai executar o webhook de consentimento positivo quando o usuário conceder um consentimento em qualquer lugar na PrivacyTools.
Pronto! Agora cada vez que um usuário der ou revogar um consentimento no seu portal da privacidade ou mesmo via API a atualização será feita no Mailchimp.