Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

magento

Adobe Commerce Eventing

Adobe Commerce Eventing provides an asynchronous event-driven integration framework that publishes Commerce business events to Adobe I/O Events, enabling App Builder applications and other Adobe Experience Cloud services to subscribe and react to store activity. Supported event types cover the full commerce lifecycle including order placement, customer registration, product updates, inventory changes, and payment processing.

Documentation Provider Profile APIs.io AsyncAPI GitHub

Adobe Commerce Eventing is one of 16 APIs that magento publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Adobe I/O, App Builder, E-Commerce, Events, and Extensibility. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 8 operations across 8 channels, and defines 13 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.

The API connects through a single server, https://eventsingress.adobe.io (https).

8 operations 8 channels 13 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0
Base URL
https://api.example.com
Contact
Adobe Commerce Developer Support
Resource Areas
1

Channels & Operations 8

Across 8 channels, the API surfaces 8 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 8
SUB
com.adobe.commerce.observer.sales_order_place_after
Order placed event
consumeOrderPlaced body
SUB
com.adobe.commerce.observer.sales_order_save_commit_after
Order saved event
consumeOrderSaved body
SUB
com.adobe.commerce.observer.customer_register_success
Customer registered event
consumeCustomerRegistered body
SUB
com.adobe.commerce.observer.customer_save_after_data_object
Customer saved event
consumeCustomerSaved body
SUB
com.adobe.commerce.observer.catalog_product_save_after
Product saved event
consumeProductSaved body
SUB
com.adobe.commerce.observer.catalog_product_delete_after_done
Product deleted event
consumeProductDeleted body
SUB
com.adobe.commerce.observer.checkout_submit_all_after
Checkout completed event
consumeCheckoutComplete body
SUB
com.adobe.commerce.observer.sales_order_creditmemo_save_after
Credit memo created event
consumeCreditMemoSaved body

Messages & Schemas 13

The contract defines 13 schemas that model the data carried by its messages. The most detailed are CustomerEventData (8 properties), OrderEventData (8 properties), CommerceEventEnvelope (8 properties), ProductEventData (7 properties). Each schema is shown below with its type and property counts.

OrderPlaced
message
Event published when a new Commerce order is placed.
OrderSaved
message
Event published when a Commerce order is updated.
CustomerRegistered
message
Event published when a new customer account is created.
CustomerSaved
message
Event published when a customer account is created or updated.
ProductSaved
message
Event published when a catalog product is created or updated.
ProductDeleted
message
Event published when a catalog product is deleted.
CheckoutComplete
message
Event published when a customer completes checkout.
CreditMemoSaved
message
Event published when a refund credit memo is created for an order.
CommerceEventEnvelope
object
CloudEvents 1.0 compliant envelope wrapping all Adobe Commerce I/O Events payloads. Adobe I/O Events uses the CloudEvents specification for all event metadata.
8 properties 6 required
CommerceEventData
object
The inner data object of a Commerce I/O Event. Contains event metadata and the nested event payload with the Commerce entity data.
5 properties
OrderEventData
object
Order data fields commonly included in order event payloads.
8 properties
CustomerEventData
object
Customer data fields commonly included in customer event payloads.
8 properties
ProductEventData
object
Product data fields commonly included in product event payloads.
7 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

magento-events-asyncapi.yml Raw ↑

Other APIs magento publishes across the network.

Magento GraphQL API
AE Profile APIs.io
Magento SOAP API
AE Profile APIs.io
Adobe Commerce Webhooks
AE Profile APIs.io
Adobe Commerce Admin UI SDK
AE Profile APIs.io
magento Authentication API
AE Profile APIs.io
magento Carts API
AE Profile APIs.io
magento Categories API
AE Profile APIs.io
magento Customers API
AE Profile APIs.io
magento Inventory API
AE Profile APIs.io
magento Invoices API
AE Profile APIs.io
magento Orders API
AE Profile APIs.io
magento Products API
AE Profile APIs.io
#Adobe I/O#App Builder#E-Commerce#Events#Extensibility
← Back to A APIs
API Details
ID
magento:events
Base URL
https://api.example.com
Docs
https://developer.adobe.com/commerce/extensibility/events/
Provider
magento
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network