2 minutes September 30, 2024

How to Set Up Flow Builder for Email Notifications Upon Plugin Installation in Shopware 6

Whenever you integrate a new plugin in Shopware 6, you should verify that the email notifications are well configured. From this guide, you will learn how to set the Flow Builder for sending out emails when a plugin has been installed.

Issue Faced

Once your plugin is installed in Shopware 6, you face the problem of configuring the creation of the Flow Builder to send an email. This view setup will make it easier in the process of sending notifications automatically to users as well as inform them of the plugin installation progress.

Step-by-Step Guide to Set Up Email Notifications for Plugin Installation in Shopware 6

To set up the Flow Builder upon plugin installation, you can use the Shopware flow repository to upsert the flow data. Below are the steps and code required to achieve this.

Step 1. Generate a Flow ID

If a flow ID is not provided, generate a new UUID for the flow.

php

   if (!$flowId) {

       $flowId = UUID::randomHex();

   }

php

if (!$flowId) {

$flowId = UUID::randomHex();

}

Step 2. Define the Event Name and Email Configuration.

Specify the event name that will trigger the flow and configure the email details.

php

   $eventName = 'plugin.installed'; // Example event name

   $mailTemplateId = 'your_mail_template_id'; // Replace with your mail template ID

   $actionName = 'action.send_mail'; // Action to send email

php

$eventName = 'plugin.installed'; // Example event name

$mailTemplateId = 'your_mail_template_id'; // Replace with your mail template ID

$actionName = 'action.send_mail'; // Action to send email

Step 3. Create the Sequences Array

Define the sequences array that includes the action for sending the email notification.

php

   $sequences = [

       [

           'actionName' => $actionName,

           'config' => [

               'documentTypeIds' => [],

               'mailTemplateId' => $mailTemplateId,

               'recipient' => [

                   'data' => [],

                   'type' => 'default',

               ]

           ],

           'displayGroup' => 1,

           'position' => 1,

       ]

   ];

php

$sequences = [

[

'actionName' => $actionName,

'config' => [

'documentTypeIds' => [],

'mailTemplateId' => $mailTemplateId,

'recipient' => [

'data' => [],

'type' => 'default',

]

'displayGroup' => 1,

'position' => 1,

]

];

Step 4. Upsert the Flow Data

Finally, use the flow repository to upsert the flow data, ensuring all necessary fields are included.

php

   $this->flowRepository->upsert(

       [

           [

               'id' => $flowId,

               'eventName' => $eventName,

               'name' => 'Flow Builder Sample Name', // Set a descriptive name for your flow

               'active' => true,

               'sequences' => $sequences

           ]

       ],

       $this->context

   );

php

$this->flowRepository->upsert(

[

'id' => $flowId,

'eventName' => $eventName,

'name' => 'Flow Builder Sample Name', // Set a descriptive name for your flow

'active' => true,

'sequences' => $sequences

]

$this->context

);

Conclusion

By following these steps, you can successfully configure the Flow Builder to send email notifications upon the installation of your Shopware 6 plugin. This automation enhances the user experience by providing timely updates and ensures that your communication processes are streamlined. For expert assistance, consider partnering with a Shopware agency to optimize your plugin management and overall e-commerce strategy.

Recent help desk articles

Greetings! I'm Aneesh Sreedharan, CEO of 2Hats Logic Solutions. At 2Hats Logic Solutions, we are dedicated to providing technical expertise and resolving your concerns in the world of technology. Our blog page serves as a resource where we share insights and experiences, offering valuable perspectives on your queries.