Configuration
Overview · Installation · Usage · FAQ · Developer notes
Connect Klaviyo
Section titled “Connect Klaviyo”- In Klaviyo open Settings > Account > API keys > Create private API key. Give it these scopes: Accounts read, Events write, Lists read and write, Profiles write, Subscriptions write.
- In the add-on settings (General) choose Email service: Klaviyo, paste the key (pk_…) and save.
- Choose the Klaviyo list for subscribers and save again. Click Test connection: the account name appears.
If your Klaviyo list uses double opt-in, Klaviyo sends its confirmation email to new subscribers.
Connect Brevo
Section titled “Connect Brevo”- In Brevo open SMTP & API > API keys > Generate a new API key.
- Choose Email service: Brevo, paste the key, save, choose the Brevo list for subscribers, save and test.
Only the default Brevo attributes are used: FIRSTNAME, LASTNAME and SMS (phone in international format).
Consent
Section titled “Consent”| Setting | Default | Meaning |
|---|---|---|
| Opt-in checkbox at checkout | on | Above Place order; hidden for customers who are already subscribed |
| Opt-in checkbox on registration and profile | on | Unticking it in the profile unsubscribes |
| Opt-in text | Email me news and special offers… | Stored with every consent |
| Pre-tick the checkbox | off | Keep it off where the law requires an active opt-in |
| Use subscriptions of the Newsletters add-on | on | Newsletters subscriptions count as consent. Where a Newsletters list is shown (checkout, registration) our checkbox stays hidden, so customers see one box |
| Sync all customers as profiles | on | Off: only customers who opted in are sent |
Events
Section titled “Events”| Event (Klaviyo / Brevo) | When |
|---|---|
| Placed Order / order_placed | Once per order, when it first gets a status that reserves stock |
| Ordered Product (Klaviyo only) | With Placed Order, one per order line |
| Fulfilled Order / order_fulfilled | Once, on the statuses you choose (default Complete) |
| Cancelled Order / order_cancelled | Once, on the statuses you choose (default Canceled) |
| Started Checkout / checkout_started | When the checkout knows the email (signed in or typed in); once per cart content and day |
| Viewed Product / product_viewed | Signed-in customers only, once per product and day |
Multi-Vendor: events are sent per vendor order, with the vendor name as a property.
Catalog
Section titled “Catalog”- Klaviyo: copy the catalog feed URL from the Catalog tab and add it in Klaviyo under Content > Products > Add custom catalog source (JSON). The feed lists active products with the Klaviyo field names ($id, $title, $link, $description, $price, $image_link, categories, stock) and is cached for an hour.
- Brevo: tick Sync products to Brevo; the cron job sends active products once a day (E-commerce must be activated in Brevo).
- Products in the catalog limits both (default 5000).