For syncing Newsletter Subscribe/Unsubscribes: also add your Klaviyo private API key
To enable error logging: set "Enable Klaviyo Logger" to "Yes"
Save config
For syncing Newsletter Subscribe/Unsubscribes:
Open Newsletter from the sidebar
The page should load with your lists from Klaviyo
Select a list
Save config
To set up Email or SMS Consent at Checkout
Open Consent at Checkout from the sidebar
Configure for each respective section:
Email
Select if want to Subscribe contacts to email marketing at checkout
Select list from drop down where to add the contacts if they choose to subscribe
Enter text for checkbox selection to email marketing
SMS
Select if want to Subscribe contacts to SMS marketing at checkout
Select list from drop down where to add the contacts if they choose to subscribe
Enter text for checkbox selection to email marketing
Enter disclosure text that appears alongside the checkbox selection
To set up Webhooks
Open Webhooks from the sidebar
create a webhook secret and enter it into the corresponding Webhook Secret field
select Yes for Use Product Delete Webhook?
To setup OAuth integration with Klaviyo
Open Setup OAuth from the sidebar
Enter integration name
Save config
Making updates
1) Follow Klaviyo's standard process of making a pull request and getting it reviewed before merging.
2) Update CHANGELOG.md. Details on formatting the changelog (including categorizing changes) can be found here: keepachangelog.com
1) If this is a change that will not immediately get sent along to Magento i.e. not a version update:
1) Add any changes under the [Unreleased] section. This will be a comparision of the most recent commits to the latest tagged version.
2) If this is a version update:
1) Make sure to increment the version in two places:
1) module.xml
2) composer.json
2) Add a new version between [Unreleased] and the most recent version. Include the incremented version number following semantic versioning practices and the date. Add your changes under this version.
3) Move any unreleased changes into your version update under the appropriate categories.
4) Update the [Unreleased] link to point from your new version to HEAD e.g. if you're updating to version 1.0.2 you'd update the link from 1.0.1...HEAD to 1.0.2...HEAD.
5) Add a link to your new version. The tag won't yet exist but you can create a link to the tag you will create shortly. Follow the pattern of previous links.
3) Upon approval merge your changes into master.
1) If this is a version update:
1) Checkout the master branch locally, make sure to pull down any changes that were just merged.
2) Use git log to find the merge commit's checksum.
3) Tag this commit with the version you just incremented: git tag -a {version} aeb8c682cebe7acee94506d3e4bfff2e5755e8c1 or just use git tag -a {version}.
4) Push the tag to the remote repository: git push origin 1.0.1 replacing with the version you've just tagged.