Events
Arlanix Notifications

For arlanix/notification 1.0.0

Events

An event is something that happens in the store that a rule can answer. Each comes with fields: what a condition compares and what the subject and the body name in braces, such as {order.increment_id}. The rule form lists an event's fields under Variables, with sample values under Preview.

The events come with the modules your developer installs:

  • Store events (arlanix/module-notification-event): orders, invoices, refunds, shipments, customers, reviews, the newsletter and the contact form.
  • Monitoring (arlanix/module-notification-monitoring): admin sign-ins, the store's health, orders that stop coming, imports and exports. See Monitoring.
  • Arlanix Product Feed (arlanix/module-feed), when the store has it: a feed that fails or delivers again, and more products left out or refused. See Get told when a feed fails.

In the tables:

  • In the message: the field is shown with the message, under the text, whatever the rule's own words.
  • Personal data: a customer's name or email, a review's text, a contact form's message, an admin's IP address. It is sent only when the rule's subject or body names it, and never shown on its own.
  • A list: the field holds a code, such as pending or 1; a condition offers its choices, and the message shows its name, such as Pending or General.

Sales

New order

An order is placed: at checkout, in the admin or through the API. Severity Info; code sales_order_placed.

Field Name
order.increment_id Order number In the message
order.grand_total Grand total A number
order.grand_total_formatted Total In the message
order.currency Currency
order.status Status In the message, a list
order.status_label Status name
order.state State
order.payment_method Payment method code
order.payment_title Payment In the message
order.shipping_method Shipping method code
order.shipping_description Shipping In the message
order.items_count Products A number
order.items_qty Quantity A number
order.items Items
order.coupon_code Coupon code
store.id Store view A list
store.name Store In the message
store.website Website
customer.is_guest Guest checkout Yes or no
customer.group Customer group A list
customer.group_label Customer group name
customer.name Customer name Personal data
customer.email Customer email Personal data

Order status changed

An order gets another status, such as Processing or On Hold. Severity Info; code sales_order_status_changed.

The fields of a new order, and:

Field Name
order.status_from Status before In the message, a list
order.status_from_label Status before, name
order.state_from State before

Invoice created

An invoice is made for an order. Severity Info; code sales_invoice_created.

The fields of a new order, and:

Field Name
invoice.increment_id Invoice number In the message
invoice.grand_total Invoice total A number
invoice.grand_total_formatted Invoiced In the message
invoice.is_paid Paid In the message, yes or no

Refund

A credit memo refunds an order, in full or in part. Severity Warning; code sales_creditmemo_created.

The fields of a new order, and:

Field Name
creditmemo.increment_id Credit memo number In the message
creditmemo.grand_total Refunded total A number
creditmemo.grand_total_formatted Refunded In the message
creditmemo.adjustment Adjustment A number

Shipment

A shipment is made for an order. Severity Info; code sales_shipment_created.

The fields of a new order, and:

Field Name
shipment.increment_id Shipment number In the message
shipment.total_qty Quantity shipped A number
shipment.tracks Tracking In the message

Orders stopped

A store view takes far fewer orders than at this time of the week, and either its shoppers still fill carts or they are gone; then, as Info, when orders come again. From Monitoring, which looks every five minutes and tells a change after two looks in a row: see Monitoring. Severity Error; code orders_stalled.

Field Name
store.id Store view A list
store.code Store view code
store.name Store In the message
store.website Website
orders.state State A list
orders.reason Reason A list: empty on recovery
orders.actual Orders In the message, a number
orders.expected Orders expected In the message, a number
carts.actual Carts In the message, a number
carts.expected Carts expected In the message, a number: empty when too few weeks of carts are kept
orders.window_minutes Minutes looked at A number
orders.summary Summary

Customers

New customer

A customer account is made: on the storefront, in the admin or through the API. Severity Info; code customer_created.

Field Name
customer.id Customer ID A number
customer.group Customer group In the message, a list
customer.group_label Customer group name
customer.website Website In the message
customer.name Customer name Personal data
customer.email Customer email Personal data
store.id Store view A list
store.name Store In the message
store.website Website

Customer group changed

A customer is moved to another customer group. Severity Info; code customer_group_changed.

Field Name
customer.id Customer ID A number
customer.group Customer group In the message, a list
customer.group_label Customer group name
customer.group_from Customer group before In the message, a list
customer.group_from_label Customer group before, name
customer.website Website
customer.name Customer name Personal data
customer.email Customer email Personal data
store.id Store view A list
store.name Store In the message
store.website Website

Newsletter subscription

Someone subscribes to the newsletter, or unsubscribes. Offered while Magento_Newsletter is enabled. Severity Info; code newsletter_subscription_changed.

Field Name
subscription.status Status In the message, a list
subscription.status_label Status name
subscription.status_from Status before In the message, a list
subscription.status_from_label Status before, name
subscription.is_customer A customer Yes or no
subscription.email Email Personal data
store.id Store view A list
store.name Store In the message
store.website Website

Contact form

Someone writes through the store's contact form. Offered while Magento_Contact is enabled. Severity Info; code contact_form_submitted.

Field Name
contact.name Name Personal data
contact.email Email Personal data
contact.telephone Telephone Personal data
contact.comment Comment Personal data
store.id Store view A list
store.name Store In the message
store.website Website

Catalog

Review to moderate

A review is written on the storefront and waits for moderation. Offered while Magento_Review is enabled. Severity Info; code review_submitted.

Field Name
product.id Product ID A number
product.sku SKU In the message
product.name Product In the message
review.title Review title Personal data
review.detail Review Personal data
review.nickname Nickname Personal data
store.id Store view A list
store.name Store In the message
store.website Website

Security

Admin login failed

Someone fails to sign in to the admin: a wrong password, a locked or an inactive user. Severity Warning; code admin_login_failed.

Field Name
admin.username Username In the message
admin.reason Reason In the message
admin.ip IP address Personal data

Admin logged in

An admin signs in. From a new address says whether from an IP address they had not signed in from in the year before, and From a new device whether from a browser they had not. Severity Info; code admin_login.

Field Name
admin.username Username In the message
admin.new_ip From a new address In the message, yes or no
admin.new_device From a new device In the message, yes or no
admin.ip IP address Personal data
admin.user_agent Browser Personal data

System

Cron job failed

A cron job ended in an error since the last check, which runs every five minutes. Severity Error; code cron_job_failed.

Field Name
cron.job_code Job In the message
cron.message Error
cron.scheduled_at Scheduled at In the message

Cron stopped

No cron job has run for the minutes set in Monitoring, 15 by default; then, as Info, when one runs again. Sent at once, past the queue, which needs cron. Severity Error; code cron_stopped.

Field Name
cron.state State A list
cron.minutes Minutes since the last run A number
cron.last_run Last run In the message
cron.summary Summary

Indexer needs reindex

An indexer needs a reindex; then, as Info, when it is valid again. Severity Warning; code indexer_invalid.

Field Name
indexer.id Indexer code
indexer.title Indexer In the message
indexer.state State A list
indexer.summary Summary

Application error

The store writes an error to its log. The same error is sent once in ten minutes. Severity Error; code app_error.

Field Name
error.message Error
error.level Level In the message
error.exception Exception In the message
error.file Where In the message

Import and export

Import finished

An import ends: from System > Data Transfer > Import, through the API or on a schedule. Rows with errors do not stop it, so Errors tells whether some were left out. Severity Info; code import_finished.

Field Name
import.entity Entity In the message, a list
import.entity_label Entity name
import.behavior Import behavior In the message, a list
import.behavior_label Import behavior name
import.file File In the message
import.created Created In the message, a number
import.updated Updated In the message, a number
import.deleted Deleted A number
import.errors Errors In the message, a number
import.user Started by In the message

The file and Started by come from the store's Import History, kept for an import from the Import page. An import run elsewhere may have neither.

Import failed

An import stops before it ends: too many errors, or one that ends it. Severity Error; code import_failed.

Field Name
import.entity Entity In the message, a list
import.entity_label Entity name
import.behavior Import behavior In the message, a list
import.behavior_label Import behavior name
import.file File In the message
import.errors Errors In the message, a number
import.message Reason
import.user Started by In the message

Export finished

An export's file is ready to download in System > Data Transfer > Export. Magento makes exports in the background, after the admin asks for one. Severity Info; code export_finished.

Field Name
export.entity Entity In the message, a list
export.entity_label Entity name
export.format Format In the message
export.file File In the message

Export failed

An export made no file, such as when nothing matched its filters. Severity Error; code export_failed.

Field Name
export.entity Entity In the message, a list
export.entity_label Entity name
export.format Format In the message
export.file File
export.message Reason

Product feeds

A feed tells a change, not every run: one that fails the same way run after run sends one message.

Feed failed

A feed's delivery fails, a feed that would be empty is not delivered, or a run stops responding; then, as Info, the first delivery that works. A feed that goes on failing another way is told again. Severity Error; code feed_failed.

Field Name
feed.id Feed In the message, a list
feed.identifier Feed identifier
feed.name Feed name
feed.type Feed type A list
feed.channel Channel In the message, a list
feed.store_id Store view A list
feed.store Store In the message
feed.state State A list: Problem or Recovered
feed.problem Problem A list: Failed, Empty, not delivered or Stopped responding; on a recovery, the one it recovers from
feed.summary Summary
feed.reason Reason

Products left out

A delivery leaves more of the feed's products out than the delivery before it. Severity Warning; code feed_products_left_out.

Field Name
feed.id Feed In the message, a list
feed.identifier Feed identifier
feed.name Feed name
feed.type Feed type A list
feed.channel Channel In the message, a list
feed.store_id Store view A list
feed.store Store In the message
products.left_out Products left out In the message, a number
products.new Newly left out A number
products.summary Summary

Products refused by the channel

The channel refuses more of the feed's products than at its last delivery: Google, for a Merchant API feed. Severity Warning; code feed_products_refused.

Field Name
feed.id Feed In the message, a list
feed.identifier Feed identifier
feed.name Feed name
feed.type Feed type A list
feed.channel Channel In the message, a list
feed.store_id Store view A list
feed.store Store In the message
products.refused Products refused In the message, a number
products.new Newly refused A number
products.summary Summary