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 Webhooks

Adobe Commerce Webhooks enable developers to configure synchronous HTTP callbacks that fire when specific events occur within a Commerce instance, allowing external systems to react in real time to store activity. Webhooks can intercept and modify request data before Commerce processes it, or trigger outbound notifications after an event completes.

Documentation Provider Profile APIs.io AsyncAPI GitHub

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

Tagged areas include E-Commerce, Events, Extensibility, Real-Time, and Webhooks. 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 20 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.

The API connects through a single server, {receiverUrl} (https).

8 operations 8 channels 20 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
PUB
/webhook/observer.sales_order_place_after
Order placed event
receiveSalesOrderPlaceAfter body
PUB
/webhook/observer.sales_order_save_after
Order updated event
receiveSalesOrderSaveAfter body
PUB
/webhook/observer.sales_order_invoice_pay
Invoice paid event
receiveSalesOrderInvoicePay body
PUB
/webhook/observer.sales_order_shipment_save_after
Order shipment saved event
receiveSalesOrderShipmentSaveAfter body
PUB
/webhook/observer.customer_save_after_data_object
Customer saved event
receiveCustomerSaveAfterDataObject body
PUB
/webhook/observer.customer_delete_after
Customer deleted event
receiveCustomerDeleteAfter body
PUB
/webhook/observer.catalog_product_save_after
Product saved event
receiveCatalogProductSaveAfter body
PUB
/webhook/observer.checkout_cart_product_add_after
Product added to cart event
receiveCheckoutCartProductAddAfter body

Messages & Schemas 20

The contract defines 20 schemas that model the data carried by its messages. The most detailed are OrderData (22 properties), AddressData (10 properties), OrderItemData (9 properties), CustomerData (9 properties). Each schema is shown below with its type and property counts.

SalesOrderPlaceAfter
message
Payload sent when a new order is placed in Commerce.
SalesOrderSaveAfter
message
Payload sent when an order record is created or updated.
SalesOrderInvoicePay
message
Payload sent when payment is captured for an invoice.
SalesOrderShipmentSaveAfter
message
Payload sent when a shipment is created or updated.
CustomerSaveAfterDataObject
message
Payload sent when a customer account is created or updated.
CustomerDeleteAfter
message
Payload sent when a customer account is deleted.
CatalogProductSaveAfter
message
Payload sent when a product is created or updated.
CheckoutCartProductAddAfter
message
Payload sent when a product is added to a shopping cart.
WebhookEnvelope
object
The outer envelope wrapping all Commerce webhook payloads. Contains metadata about the event and the nested event data object.
5 properties
SalesOrderPayload
object
Webhook payload for sales order events.
1 property
OrderData
object
Order data included in order-related webhook payloads.
22 properties
OrderItemData
object
A line item in an order webhook payload.
9 properties
AddressData
object
Address data included in order and customer webhook payloads.
10 properties
PaymentData
object
Payment method data included in order webhook payloads.
3 properties
InvoicePayload
object
Webhook payload for invoice payment events.
1 property
ShipmentPayload
object
Webhook payload for shipment events.
1 property
CustomerPayload
object
Webhook payload for customer account events.
1 property
CustomerData
object
Customer data object included in customer event payloads.
9 properties
ProductPayload
object
Webhook payload for catalog product events.
1 property
CartAddPayload
object
Webhook payload for cart product add events.
1 property

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

magento-webhooks-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 Admin UI SDK
AE Profile APIs.io
Adobe Commerce Eventing
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
#E-Commerce#Events#Extensibility#Real-Time#Webhooks
← Back to A APIs
API Details
ID
magento:webhooks
Base URL
https://api.example.com
Docs
https://developer.adobe.com/commerce/extensibility/webhooks/
Provider
magento
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network