Event Messages

Event Messages

Event messages are sent by Elastic Path Commerce services when important events occur. Many of these events are consumed by Integration Server, but custom consumer queues can be created to allow messages to be consumed by other services.

Most of these event messages use ActiveMQ Virtual Topics, which relays incoming messages to one or more consumer queues.

Event messages are sent using a JSON format as shown in the example below:

{
    "eventType": {
        "@class": "OrderEvent",
        "name": "ORDER_RELEASED"
    },
    "guid": "20000",
    "data": {}
}

Event Types

Catalog events

Catalog events are sent to the Virtual Topic defined by the COMMERCE/SYSTEM/MESSAGING/CATALOG/channelUri setting definition. By default this is set to jms:topic:VirtualTopic.ep.catalog.

For information about catalog events, see Catalog Syndication events.

Commerce Manager user events

Commerce Manager user events are sent to the Virtual Topic defined by the COMMERCE/SYSTEM/MESSAGING/CMUSERS/channelUri setting definition. By default this is set to jms:topic:VirtualTopic.ep.cmusers.

The following event types are supported:

• CM_USER_CREATED - Invoked by Commerce Manager when a new Commerce Manager user is created.
• PASSWORD_RESET - Invoked by Commerce Manager when a Commerce Manager user requests a password reset.
• PASSWORD_CHANGED - Invoked by Commerce Manager when a Commerce Manager user’s password is changed.

Customer events

Customer events are sent to the Virtual Topic defined by the COMMERCE/SYSTEM/MESSAGING/CUSTOMERS/channelUri setting definition. By default this is set to jms:topic:VirtualTopic.ep.customers.

The following event types are supported:

• CUSTOMER_REGISTERED - Invoked when a customer registers in Cortex.
• PASSWORD_CHANGED - Not invoked by platform code.
• PASSWORD_FORGOTTEN - Invoked by Commerce Manager when a user’s password is reset.
• ANONYMOUS_CUSTOMER_REGISTERED - Invoked by Commerce Manager when an anonymous user is converted to a registered user.
• WISH_LIST_SHARED - Not invoked by platform code.
• ACCOUNT_CREATED - Invoked when a new account is created in Commerce Manager.

Data import events

Customer events are sent to the Virtual Topic defined by the COMMERCE/SYSTEM/MESSAGING/DATAIMPORT/channelUri setting definition. By default this is set to jms:topic:VirtualTopic.ep.customers.

The following event types are supported:

• IMPORT_JOB_COMPLETED - Invoked by Commerce Manager when a CSV data import job is completed.

Domain events

Customer events are sent to the Virtual Topic defined by the COMMERCE/SYSTEM/MESSAGING/DOMAIN/channelUri setting definition. By default this is set to jms:topic:VirtualTopic.ep.customers.

For information about domain events, see Catalog Syndication events.

Gift certificate events

Gift certificate events are sent to the Virtual Topic defined by the COMMERCE/SYSTEM/MESSAGING/GIFTCERTIFICATES/channelUri setting definition. By default this is set to jms:topic:VirtualTopic.ep.giftcertificates.

The following event types are supported:

• GIFT_CERTIFICATE_CREATED - Invoked by Cortex during checkout when a gift certificate is created.
• RESEND_GIFT_CERTIFICATE - Invoked by Commerce Manager when the "Resend Gift Certificate" action is used.

Order events

Order events are sent to the Virtual Topic defined by the COMMERCE/SYSTEM/MESSAGING/ORDERS/channelUri setting definition. By default this is set to jms:topic:VirtualTopic.ep.orders.

The following event types are supported:

• ORDER_CREATED - Invoked by Cortex at the end of the synchronous checkout flow, regardless of whether the order is held or not.
• ORDER_SHIPMENT_SHIPPED - Invoked when a physical shipment is shipped.
• RESEND_ORDER_CONFIRMATION - Invoked by Commerce Manager when the "Resend Order Confirmation" action is used.
• ORDER_SHIPMENT_RELEASE_FAILED - Invoked if shipment release fails.
• RETURN_CREATED - Invoked by Commerce Manager when a return is created.
• EXCHANGE_CREATED - Invoked by Commerce Manager when an exchange is created.
• RESEND_RETURN_EXCHANGE_NOTIFICATION - Invoked by Commerce Manager when the "Resend Return" or "Resend Exchange" actions are used.
• ORDER_HELD - Invoked by Cortex during synchronous checkout flow if an order hold strategy requests a hold.
• ORDER_CANCELLED - Invoked if an order is cancelled.
• ORDER_RELEASED - Invoked by Integration Server during asynchronous checkout.
• ORDER_ACCEPTED - Invoked by Cortex at the end of the synchronous checkout flow if no holds are requested, or by Integration Server once all the holds have been resolved.
• ORDER_HOLD_UPDATE - Invoked by Commerce Manager when a hold is marked resolved or unresolvable.
• ORDER_FAILED - Invoked by Cortex if checkout fails.
• ORDER_ON_HOLD - Invoked by Batch Server if one or more orders is currently on hold.