aligent/magento2-default-async-events

A set of default events for use with the aligent/magento-async-events module

v1.0.0 2022-11-07 03:27 UTC

Requires

• php: >=7.4
• aligent/async-events: ^2.3|^3.0
• magento/framework: *

GPL-3.0-only

README

This module is an add-on for the Aligent magento-async-events module, and adds event triggers for:

• Order save
• Shipment save
• Customer save

Installation

1. Install the module via composer:

composer require aligent/magento2-default-async-events

1. (Optional) Install the Aligent magento2-eventbridge-notifier module in order to send events to AWS EventBridge

composer require aligent/magento2-eventbride-notifier

1. Enable modules

bin/magento module:enable Aligent_AsyncEvents Aligent_DefaultAsyncEvents Aligent_EventBridge

1. Run setup upgrade

bin/magento setup:upgrade

Configuration

Configuration options can be found under Stores -> Configuration -> Services -> Async Events

• Enable/Disable publication of order events
• Select order statuses for which to send events
• Enable/Disable publication of shipment events
• Enable/Disable publication of customer events

Event Subscription

This module defines 3 events:

• sales.order.saved
• sales.shipment.saved
• customer.saved

These events can be subscribed to using the REST endpoint V1/async_event as described in the wiki. Your API user will require appropriate permissions to subscribe.