sysint/module-email-flow

Connect email data to workflow automation and integrate with any app

Maintainers

Details

github.com/sysintnet/module-email-flow

Source

Issues

Installs: 5

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Type:magento2-module

1.0.0 2023-10-20 09:46 UTC

Requires

  • php: ~7.4.0||~8.1.0||~8.2.0
  • magento/framework: 103.0.*
  • magento/module-email: 101.1.*

MIT c3adbf14d2fc48df3fe31b4b44247861efd508d3

emailworkflowautomationmagentozapiern8n

This package is auto-updated.

Last update: 2024-09-20 15:17:28 UTC

README

Easily integrate your Magento 2 store with workflow automation platforms like n8n, Zapier, and many more using just one module. Send Magento 2 emails as JSON to webhooks and bridge your store to countless services such as MailChimp, Sendgrid, HubSpot, ActiveCampaign, CRM systems, and others without needing any additional backend plugins.

It's not another SMTP provider, it's a way to send e-commerce data to an automation tool to easily connect any app without extra coding and installing additional plugins to your Magento store. This module is not a replacement for your current email provider and does not change your SMTP settings. Although you can only use workflow n8n or Zapier to send emails and SMS, by default emails will be sent through your current email provider and workflow, but you can always change this.

N8N Example workflow image

Table of Contents

  1. Features
  2. Installation
  3. Configuration
  4. Usage
  5. Compatibility
  6. Support
  7. License

Features

  • Real-time Email Dispatching: Send your Magento store emails and objects like Customer, Order & etc., as JSON payloads in real-time.
  • Universal Webhook Integration: Easily connect to platforms like n8n, Zapier, and many others.
  • Plug & Play: No need for additional backend plugins or integrations.
  • Secure: Ensures that data is sent securely over HTTPS to the designated webhook. Supports Base Auth and API Auth.

Installation

Composer install

composer require sysint/module-email-flow

Download the module

Extract the files to your Magento installation's app/code directory. Run the following commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

The module will now be installed and ready for configuration.

Configuration

Navigate to Stores > Configuration > Advanced > System > Email Flow Sending Settings image

  1. Enable plugin
  2. Input your webhook URL.
  3. Sending mode. By default, mixed means that emails will be sent by SMTP + FLOW. You'll be able to set up your workflow and keep sending emails.
  4. Select authentication type: NONE, Base, API (NONE by default)
  5. Debug: Yes/No (No - by default). Log file var/log/debug.log
  6. Data Optimization Yes/No (Yes - by default)
  7. Save the configuration.

Usage

Once configured, the module will automatically send emails as JSON payloads to the specified webhook URL in real-time. This data can then be used in your preferred workflow automation platform to trigger workflows, save data, and integrate with other services like Mailchimp, Sendgrid, HubSpot & etc.

When debugging is enabled, messages can be found in the log file var/log/debug.log Example of the message: [2023-10-20T07:51:34.110881+00:00] .DEBUG: {"message":"Workflow was started"} [] []

Tested across platforms

  • N8N
  • Zapier

Compatibility

  • Magento Open Source/Adobe Commerce Cloud/B2B, versions:
    • 2.4.6 - 2.4.6-p3
    • 2.4.5 - 2.4.5-p5
    • 2.4.4 - 2.4.4-p6
  • PHP
    • 7.3
    • 7.4
    • 8.1
    • 8.2

Support

For any issues, questions, or feedback, please open an issue on our GitHub repository

License

This module is licensed under the MIT License - see the LICENSE file for details