Event management commands

Adobe I/O Events allow you to receive notifications of real-time events taking place in Adobe services.

Adobe Commerce provides the following commands to configure and process events:

Enable integration between Commerce and Adobe I/O events
Manage event subscriptions
Generate a Commerce module
- events:generate:module

Create an event provider

The events:create-event-provider command creates an event provider ID in Adobe IO Events and displays this ID. Add the generated ID as the value of the Stores > Configuration > Adobe Services > Adobe IO Events > Adobe I/O Event Provider ID field in the Commerce Admin.

The --label and --description arguments are optional. However, if you do not specify them, then you must create a system app/etc/event-types.json file and define the values in that file before running the events:create-event-provider command. We recommend specifying the --label and --description arguments when you run the command.

If you decide to omit the arguments, the event-types.json file must have the following format:

{
 "provider": {
     "label": "My Adobe Commerce Events",
     "description": "Provides out-of-process extensibility for Adobe Commerce"
     }
 }
Copied to your clipboard
{
 "provider": {
     "label": "My Adobe Commerce Events",
     "description": "Provides out-of-process extensibility for Adobe Commerce"
     }
 }

As an alternative to above steps, you can click the Create Event Provider button on the General configuration section of the Adobe I/O Events page in the Admin.

Usage

bin/magento events:create-event-provider --label "<unique_provider_label>" --description "<provider description>"

Arguments

--label A name that distinguishes your event provider from others in the project. The name can contain English alphanumeric characters, spaces, underscores (_), and hyphens (-) only. The first character must be a letter.

--description A string that describes your event provider. The string can contain English alphanumeric characters, spaces, underscores (_), and hyphens (-) only.

Example

bin/magento events:create-event-provider --label "my_new_event_provider" --description "Event provider for my workspace"
Copied to your clipboard
bin/magento events:create-event-provider --label "my_new_event_provider" --description "Event provider for my workspace"

Response

No event provider found, a new event provider will be created

A new event provider has been created with ID <ID>.
Copied to your clipboard
No event provider found, a new event provider will be created

A new event provider has been created with ID <ID>.

Get details about a configured event provider

The events:provider:info command returns details about a configured event provider.

Usage

events:provider:info

Example

bin/magento events:provider:info
Copied to your clipboard
bin/magento events:provider:info

Response

Configured event provider details:
- id: abcdef12-e499-5a0a-a683-1234567890ab
- label: test provider
- description: testing local provider creation (Instance docs-stage-testing)
Copied to your clipboard
Configured event provider details:
- id: abcdef12-e499-5a0a-a683-1234567890ab
- label: test provider
- description: testing local provider creation (Instance docs-stage-testing)

Get details about configured event registrations in your App Builder application

The bin/magento events:registrations:list command returns details about configured event registrations.

Usage

events:registrations:list

Example

bin/magento events:registrations:list
Copied to your clipboard
bin/magento events:registrations:list

Response

- Event registration 1 (5eb5106d-0e84-4c2e-ae73-b22b266a7908)
Copied to your clipboard
- Event registration 1 (5eb5106d-0e84-4c2e-ae73-b22b266a7908)

Specify the -vv option to increase the verbosity of information about the subscribed events.

bin/magento events:registrations:list -vv
Copied to your clipboard
bin/magento events:registrations:list -vv

Response

+----------------------+--------------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name                 | registration_id                      | enabled | events                                                                                                                                                                          |
+----------------------+--------------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Event registration 1 | 5eb5106d-0e84-4c2e-ae73-b22b266a7908 | 1       | [                                                                                                                                                                               |
|                      |                                      |         |     { code: com.adobe.commerce.observer.catalog_product_commit_after2, provider_id: e763142d-0439-4022-abeb-6227a396bbd2, label: Observer event catalog_product_commit_after2 } |
|                      |                                      |         | ]                                                                                                                                                                               |
+----------------------+--------------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Copied to your clipboard
+----------------------+--------------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name                 | registration_id                      | enabled | events                                                                                                                                                                          |
+----------------------+--------------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Event registration 1 | 5eb5106d-0e84-4c2e-ae73-b22b266a7908 | 1       | [                                                                                                                                                                               |
|                      |                                      |         |     { code: com.adobe.commerce.observer.catalog_product_commit_after2, provider_id: e763142d-0439-4022-abeb-6227a396bbd2, label: Observer event catalog_product_commit_after2 } |
|                      |                                      |         | ]                                                                                                                                                                               |
+----------------------+--------------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Create event metadata in Adobe I/O

The events:metadata:populate command creates event metadata based on XML and application configurations. This metadata gets linked to the configured event provider.

Event metadata is automatically created for new event subscriptions when you run the events:subscribe command and synchronize events registered in io_events.xml files or config.php when the setup:upgrade command runs. In the following situations, we recommend creating event metadata using the events:metadata:populate command:

You have configured an event provider after an io_events.xml file was pushed to your cloud instance and a redeployment has not occurred since this change.
You have not run setup:upgrade since adding an io_events.xml file to your on-premise instance.
You manually edited the event subscriptions configuration in app/etc/config.php.

As an alternative to running this command, you can click the Execute Synchronization button on the General configuration section of the Adobe I/O Events page in the Admin.

Usage

events:metadata:populate

Example

bin/magento events:metadata:populate
Copied to your clipboard
bin/magento events:metadata:populate

The events:subscribe command subscribes the current provider to the specified event. You must define the event code using the following pattern:

<type>.<event_name>
Copied to your clipboard
<type>.<event_name>

where:

type specifies the origin of the event. Specify observer if the event is emitted by a Commerce observer, or specify plugin if the event is emitted by a plugin.
event_name identifies the event to subscribe. For example: catalog_product_save_after.

The --fields command option defines which fields within an event to send to your external application. To send all fields, specify --fields='*'. If you want to send only specific fields, use a separate instance of the --fields command option to define each field to transmit. You cannot use a * wildcard character to match partial strings.

If the Commerce event contains objects, use dotted notation to specify fields within an object. For example, if your event contains a stock_data object, and you want to send its product_id and qty fields, you would specify the --fields stock_data.product_id and --fields stock_data.qty command options. Commerce module development provides a detailed example of using files to register events.

Adobe recommends sending a limited number of fields per event. If you send all fields, you increase the risk of including sensitive or PCI-compliant data in the event. In addition, specifying only the fields that are applicable to your business case is recommended for optimal performance and cost effectiveness.

The command supports observer events by default. You must perform additional steps to subscribe to a plugin event:

Run the bin/magento events:subscribe --fields <event_code> --force command to force the subscription.
Run the bin/magento events:generate:module command to generate or regenerate the AdobeCommerceEvents module.
Run the bin/magento setup:di:compile command to create the classes necessary to handle the event.

You can also subscribe to a plugin event if it was registered in the app/etc/config.php file and subsequently unsubscribed with the events:unsubscribe command. Register events describes the format of these files.

You can also create and subscribe to a conditional event. Conditional events allow you to determine the conditions that the Commerce events client module uses to emit native or custom events to your application. See Create conditional events for detailed information and examples.

If you are implementing eventing in a performance testing environment, run the bin/magento setup:perf:generate-fixtures command before subscribing any events. Subscribing events before generating fixtures can cause errors.

Usage

bin/magento events:subscribe <event_code> --force --fields=<name1> --fields=<name2> --parent <event_code> --rules=<field-name>|<operator>|<value> --rules=<field-name2>|<operator>|<value2> --hipaaAuditRequired --priority --destination=<destination>

Arguments

<event_code> Required. Specifies the event to subscribe to. The value must be in the format <type.event_name>.

Options

--fields='{"<name>":"<field-name>", "converter":"<path\to\converterclass>"}' Required, but the converter argument is optional. Specifies an event field to transmit to the Adobe App Builder application. You can specify this option multiple times. Each instance can contain only one field name. The converter argument applies the converter class to the specified field.

--force, -f Forces subscription to the event, even if it hasn't been defined locally.

--parent=<event code> Specifies the name of the event to use as the basis of an event rule. If you specify this option, you must also specify the --rules option.

--priority, -p Expedites the transmission of this event. Specify this option for events that need to be delivered immediately. By default, events are sent by cron once per minute.

--rules=<field-name>|<operator>|<value> Defines a rule that will be applied to the subscribed event. You can apply multiple rules to an event, but each rule must be defined separately. A rule definition must specify the field to be evaluated, an operator, and the value to be evaluated, in that order. The field name in a rule definition does not have to match a field specified with the --fields option.

--fields='{"<name>":"<field-name>", "converter":"<path\to\converterclass>"}' Applies the converter class to the given field.

--destination, -d A custom destination for the event. This argument is used for SaaS integrations.

--hipaaAuditRequired Indicates the event contains data that is subject to HIPAA auditing.`

Example

To subscribe to a native event:

bin/magento events:subscribe observer.catalog_product_save_after --fields=sku --fields=stock_data.qty 
Copied to your clipboard
bin/magento events:subscribe observer.catalog_product_save_after --fields=sku --fields=stock_data.qty

To create and subscribe to a conditional event based on observer.catalog_product_save_after:

bin/magento events:subscribe observer.catalog_product_save_after_low_quantity \
--parent observer.catalog_product_save_after \
--fields=sku --fields=stock_data.qty \
--rules="stock_data.qty|lessThan|20" --rules="name|regex|/^TV .*/i"
Copied to your clipboard
bin/magento events:subscribe observer.catalog_product_save_after_low_quantity \
--parent observer.catalog_product_save_after \
--fields=sku --fields=stock_data.qty \
--rules="stock_data.qty|lessThan|20" --rules="name|regex|/^TV .*/i"

Response

The subscription com.adobe.commerce.observer.catalog_product_save_after was successfully created
Copied to your clipboard
The subscription com.adobe.commerce.observer.catalog_product_save_after was successfully created

Unsubscribe from a Commerce event

The events:unsubscribe command causes the current provider to unsubscribe from the specified event. You cannot unsubscribe from events defined in a module's or root etc/io_events.xml file. However, you can unsubscribe events that were registered in the app/etc/config.php file or from the events:subscribe command.

Use the events:list command to retrieve a list of subscribed events.

Usage

bin/magento events:unsubscribe <event_code>

Arguments

<event_code> Required. Specifies the event to unsubscribe from.

Example

bin/magento events:unsubscribe observer.catalog_product_save_after
Copied to your clipboard
bin/magento events:unsubscribe observer.catalog_product_save_after

Response

Successfully unsubscribed from the `observer.catalog_product_save_after` event
Copied to your clipboard
Successfully unsubscribed from the `observer.catalog_product_save_after` event

List subscribed Commerce events

The events:list command returns a list of subscribed events.

Usage

bin/magento events:list

Example

bin/magento events:list
Copied to your clipboard
bin/magento events:list

Response

observer.catalog_product_save_after
observer.customer_login
Copied to your clipboard
observer.catalog_product_save_after
observer.customer_login

List supported events

The events:list:all command returns a list of supported events defined in the specified module. (Commerce Eventing does not support all possible events.) The command returns an error if the specified module has been disabled.

If the module does not contain any supported events, the command does not return any results.

Usage

bin/magento events:list:all <module_name>

Arguments

<module_name> Required. Specifies the module to query.

Example

bin/magento events:list:all Magento_Store
Copied to your clipboard
bin/magento events:list:all Magento_Store

Response

observer.store_add
observer.store_address_format
observer.store_delete_after
observer.store_delete_commit_after
observer.store_group_delete_after
observer.store_group_delete_commit_after
observer.store_group_save_after
observer.store_group_save_commit_after
observer.store_save_after
observer.store_save_commit_after
observer.website_delete_after
observer.website_delete_commit_after
observer.website_save_after
observer.website_save_commit_after
plugin.magento.store.model.resource_model.group.delete
plugin.magento.store.model.resource_model.group.save
plugin.magento.store.model.resource_model.store.delete
plugin.magento.store.model.resource_model.store.save
plugin.magento.store.model.resource_model.website.delete
plugin.magento.store.model.resource_model.website.save
Copied to your clipboard
observer.store_add
observer.store_address_format
observer.store_delete_after
observer.store_delete_commit_after
observer.store_group_delete_after
observer.store_group_delete_commit_after
observer.store_group_save_after
observer.store_group_save_commit_after
observer.store_save_after
observer.store_save_commit_after
observer.website_delete_after
observer.website_delete_commit_after
observer.website_save_after
observer.website_save_commit_after
plugin.magento.store.model.resource_model.group.delete
plugin.magento.store.model.resource_model.group.save
plugin.magento.store.model.resource_model.store.delete
plugin.magento.store.model.resource_model.store.save
plugin.magento.store.model.resource_model.website.delete
plugin.magento.store.model.resource_model.website.save

Response

The events metadata was successfully created:
Copied to your clipboard
The events metadata was successfully created:

Return event details

The events:info command returns the payload of the specified event in JSON format.

Usage

bin/magento events:info [--depth=<integer>] <event_code>

Arguments

<event_code> Required. Specifies the event to query.

Options

--depth=<integer> Optional. Determines how many nested levels of the payload to return. The default value is 2.

Example

bin/magento events:info plugin.magento.customer.api.customer_repository.save --depth=1

Response

If the depth value of 2 was specified, the response would also include details about the addresses and extension_attributes objects.

{
    "id": "int",
    "group_id": "int",
    "default_billing": "string",
    "default_shipping": "string",
    "confirmation": "string",
    "created_at": "string",
    "updated_at": "string",
    "created_in": "string",
    "dob": "string",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "prefix": "string",
    "suffix": "string",
    "gender": "int",
    "store_id": "int",
    "taxvat": "string",
    "website_id": "int",
    "addresses": "\Magento\Customer\Api\Data\AddressInterface[]",
    "disable_auto_group_change": "int",
    "extension_attributes": "\Magento\Customer\Api\Data\CustomerExtensionInterface"
}
Copied to your clipboard
{
    "id": "int",
    "group_id": "int",
    "default_billing": "string",
    "default_shipping": "string",
    "confirmation": "string",
    "created_at": "string",
    "updated_at": "string",
    "created_in": "string",
    "dob": "string",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "prefix": "string",
    "suffix": "string",
    "gender": "int",
    "store_id": "int",
    "taxvat": "string",
    "website_id": "int",
    "addresses": "\Magento\Customer\Api\Data\AddressInterface[]",
    "disable_auto_group_change": "int",
    "extension_attributes": "\Magento\Customer\Api\Data\CustomerExtensionInterface"
}

Generate a Commerce module based on a list of subscribed events

The events:generate:module command generates a module with plugins based on your configuration and places it into the Commerce app/code/Magento/AdobeCommerceEvents directory. This command is applicable for on-premises deployments only.

Usage

bin/magento events:generate:module

Example

bin/magento events:generate:module
Copied to your clipboard
bin/magento events:generate:module

Response

Module was generated in the app/code/Magento directory
Copied to your clipboard
Module was generated in the app/code/Magento directory

Convert payload field values

API reference

Last updated 7/31/2024

Was this helpful?

Yes

Event management commands

Create an event provider.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Usage.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Arguments

Example

Response

Get details about a configured event provider

Usage

Example

Response

Get details about configured event registrations in your App Builder application

Usage

Example

Response

Response

Create event metadata in Adobe I/O

Usage

Example

Subscribe to an event

Usage

Arguments

Options

Example

Response

Unsubscribe from a Commerce event

Usage

Arguments

Example

Response

List subscribed Commerce events

Usage

Example

Response

List supported events

Usage

Arguments

Example

Response

Response

Return event details

Usage

Arguments

Options

Example

Response

Generate a Commerce module based on a list of subscribed events

Usage

Example

Response

Create an event provider

Usage