📢 Use this project, contribute to it or open issues to help evolve it using Store Discussion.

The Marketer

The Marketer is an application that connects VTEX to The Marketer platform in order to send events, data about orders, products, categories, brands and users and thus allowing you to send newsletters and integrate loyalty programs.

Installing The Marketer app

1. Access the Apps section in your account's admin page and look for the "The Marketer" box;
2. Then, click on the Install button;
3. Add the tracking key, rest API key, customer ID settings from The Marketer platform and configuration of the feed generation crons
4. Click on Save.

Configure Master Data Triggers for Newsletter

0. Replace {account} with the actual account name in VTEX
1. Go to the https://{account}.ds.vtexcrm.com.br page > Triggers
2. We will create 3 triggers on the CL (Clients) entity with the following names:
   • Subscribe theMarketer (ON INSERT)
   • Subscribe theMarketer (ON UPDATE)
   • Unsubscribe theMarketer (ON UPDATE)

Subscribe theMarketer (ON INSERT)

1. For the Rules tab, add a new filter on Recebe Newsletter?, condition Igual, value True and Trigger rule should be Um registro for inserido
2. For the Schedule tab, tick Run ASAP
3. For the If positive tab
   • Action should be Send an HTTP request
   • Method should be POST
   • URL: https://{account}.myvtex.com/themarketer/webhooks/subscribe
   • Content as JSON should be:

{
  "email": "{!email}",
  "firstName": "{!firstName}",
  "lastName": "{!lastName}",
  "phone": "{!phone}"
}

Subscribe theMarketer (ON UPDATE)

1. For the Rules tab, add a new filter on Recebe Newsletter?, condition Igual, value True and Trigger rule should be Um registro for alterado
2. For the Schedule tab, tick Run ASAP
3. For the If positive tab
   • Action should be Send an HTTP request
   • Method should be POST
   • URL: https://{account}.myvtex.com/themarketer/webhooks/subscribe
   • Content as JSON should be:

{
  "email": "{!email}",
  "firstName": "{!firstName}",
  "lastName": "{!lastName}",
  "phone": "{!phone}"
}

Unsubscribe theMarketer (ON UPDATE)

1. For the Rules tab, add a new filter on Recebe Newsletter?, condition Igual, value False and Trigger rule should be Um registro for alterado
2. For the Schedule tab, tick Run ASAP
3. For the If positive tab
   • Action should be Send an HTTP request
   • Method should be POST
   • URL: https://{account}.myvtex.com/themarketer/webhooks/unsubscribe
   • Content as JSON should be:

{
  "email": "{!email}"
}

The reason why there are 3 triggers instead of 2 is that on the If Negative tab, the adding new action functionality doesn't work properly, therefor we need a third trigger for the unsubscribe event

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Razvan Udrea 💻

This project follows the all-contributors specification. Contributions of any kind welcome!