• Documentation >
• Commerce >
• Transactional emails >
• Transactional emails

Transactional emails

Transactional emails are messages that Ibexa DXP can send through Actito gateway to your end-users to notify them about changes in the status of various actions taken in relation to your commerce presence.

By default, notifications are sent in relation to the following events, to an email address of the end-user who has originated these events:

• Order processing:
  • order is created
  • order is processing
  • order is completed
  • order is cancelled
• Payment:
  • payment failed
  • payment has been cancelled
• Shipment:
  • order is shipped
• User registration:
  • user has been registered
• Password reset:
  • password reset request has been submitted

You can change the events that trigger sending a transactional email.

Configure transactional emails

Install package

Transactional email support comes as an additional package that needs to be downloaded separately:

composer require ibexa/connector-actito

Flex installs and activates the package.

Configure Actito integration

Before you can start configuring the notifier engine to process and dispatch notifications to be forwarded as transactional emails, you must first obtain and configure an Actito license.

Once you gain access to the Actito dashboard:

1. Configure the API to make calls with the GET method.

2. Get the API key and entity name.

3. Set these values in the YAML configuration files, under the ibexa.system.default.connector_actito key:

ibexa:
    system:
        default:
            connector_actito:
                api_key: 12ea56789o1ea56789012ea56789o12e
                entity: <entity_name>

4. Define profile table in Actito database for storing notification attributes.

Note

By default, a trigger message coming from Ibexa DXP contains the following attributes with information about the end-user: name, surname, and email.

Those attributes can then be used to present statistics in the Actito dashboard. If this set of attributes is insufficient for your needs, you can add more attributes to the trigger message.

Create email campaigns

Create campaigns of transactional email type, one for each notification type that you want to deliver. When you build a campaign template, make sure that you use the variables supported by Ibexa DXP. For a complete list of parameters, see Transactional email variables reference.

Tip

When you invent names for your campaigns, keep them simple, and do not use special characters or spaces.

Campaign emails can be sent in one language only. To send emails in different languages, for example, because your application serves end-users from different locales, for each notification and language pair, you must create a separate campaign and extend the solution to support that.

Configure mapping

After you create and configure campaigns in Actito user interface, one for each type of notifications coming from Ibexa DXP, in YAML configuration files, under the ibexa.system.default.connector_actito.campaign_mapping key, you define mappings between notifications and email campaigns, for example:

campaign_mapping:
    Ibexa\Contracts\Payment\Notification\PaymentWorkflowStateChange:
        campaign: <actito_campaign_name_1>

    Ibexa\Contracts\OrderManagement\Notification\OrderWorkflowStateChange:
        campaign: <actito_campaign_name_2>

    Ibexa\Contracts\Shipping\Notification\ShipmentWorkflowStateChange:
        campaign: <actito_campaign_name_3>

    Ibexa\Contracts\User\Notification\UserPasswordReset:
        campaign: <actito_campaign_name_4>

    Ibexa\Contracts\User\Notification\UserRegister:
        campaign: <actito_campaign_name_5>