diff --git a/EVENTS_SCHEMA.json b/EVENTS_SCHEMA.json new file mode 100644 index 00000000..3dd84111 --- /dev/null +++ b/EVENTS_SCHEMA.json @@ -0,0 +1,867 @@ +{ + "customer_login": { + "customer": { + "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": [ + { + "id": "int", + "customer_id": "int", + "region": "object{}", + "region_id": "int", + "country_id": "string", + "street": "string[]", + "company": "string", + "telephone": "string", + "fax": "string", + "postcode": "string", + "city": "string", + "firstname": "string", + "lastname": "string", + "middlename": "string", + "prefix": "string", + "suffix": "string", + "vat_id": "string", + "default_shipping": "bool", + "default_billing": "bool", + "extension_attributes": "object{}" + } + ], + "disable_auto_group_change": "int", + "extension_attributes": { + "company_attributes": "object{}", + "all_company_attributes": "object{}[]", + "is_subscribed": "boolean", + "assistance_allowed": "integer" + } + } + }, + "customer_register_success": { + "customer": { + "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": [ + { + "id": "int", + "customer_id": "int", + "region": "object{}", + "region_id": "int", + "country_id": "string", + "street": "string[]", + "company": "string", + "telephone": "string", + "fax": "string", + "postcode": "string", + "city": "string", + "firstname": "string", + "lastname": "string", + "middlename": "string", + "prefix": "string", + "suffix": "string", + "vat_id": "string", + "default_shipping": "bool", + "default_billing": "bool", + "extension_attributes": "object{}" + } + ], + "disable_auto_group_change": "int", + "extension_attributes": { + "company_attributes": "object{}", + "all_company_attributes": "object{}[]", + "is_subscribed": "boolean", + "assistance_allowed": "integer" + } + }, + "account_controller": [] + }, + "customer_save_after": { + "data_model": "object{}", + "group_id": "int", + "tax_class_id": "int", + "shared_store_ids": "array", + "shared_website_ids": "int[]", + "password_confirm": "string", + "password": "string", + "_origData": "array", + "_isNew": "boolean" + }, + "customer_save_commit_after": { + "data_model": "object{}", + "group_id": "int", + "tax_class_id": "int", + "shared_store_ids": "array", + "shared_website_ids": "int[]", + "password_confirm": "string", + "password": "string", + "_origData": "array", + "_isNew": "boolean" + }, + "customer_delete_commit_after": { + "data_model": "object{}", + "group_id": "int", + "tax_class_id": "int", + "shared_store_ids": "array", + "shared_website_ids": "int[]", + "password_confirm": "string", + "password": "string", + "_origData": "array", + "_isNew": "boolean" + }, + "customer_group_save_commit_after": { + "tax_class_name": "string", + "_origData": "array", + "_isNew": "boolean" + }, + "customer_group_delete_commit_after": { + "tax_class_name": "string", + "_origData": "array", + "_isNew": "boolean" + }, + "catalog_category_save_after": { + "products_position": "array", + "store_ids": "array", + "store_id": "int", + "url": "string", + "parent_category": "object{}", + "parent_id": "int", + "custom_design_date": "array", + "path_ids": "array", + "level": "int", + "request_path": "string", + "name": "string", + "product_count": "int", + "available_sort_by": "array", + "default_sort_by": "string", + "path": "string", + "position": "int", + "children_count": "int", + "created_at": "string", + "updated_at": "string", + "is_active": "bool", + "category_id": "int", + "display_mode": "string", + "include_in_menu": "bool", + "url_key": "string", + "children_data": "object{}[]", + "_origData": "array", + "_isNew": "boolean" + }, + "catalog_category_delete_after": { + "products_position": "array", + "store_ids": "array", + "store_id": "int", + "url": "string", + "parent_category": "object{}", + "parent_id": "int", + "custom_design_date": "array", + "path_ids": "array", + "level": "int", + "request_path": "string", + "name": "string", + "product_count": "int", + "available_sort_by": "array", + "default_sort_by": "string", + "path": "string", + "position": "int", + "children_count": "int", + "created_at": "string", + "updated_at": "string", + "is_active": "bool", + "category_id": "int", + "display_mode": "string", + "include_in_menu": "bool", + "url_key": "string", + "children_data": "object{}[]", + "_origData": "array", + "_isNew": "boolean" + }, + "catalog_product_save_after": { + "store_id": "int", + "name": "string", + "price": "float", + "visibility": "int", + "attribute_set_id": "int", + "created_at": "string", + "updated_at": "string", + "type_id": "array", + "status": "int", + "category_id": "int", + "category": "object{}", + "category_ids": "array", + "website_ids": "array", + "store_ids": "array", + "qty": "float", + "data_changed": "bool", + "calculated_final_price": "float", + "minimal_price": "float", + "special_price": "float", + "special_from_date": "mixed", + "special_to_date": "mixed", + "related_products": "array", + "related_product_ids": "array", + "up_sell_products": "array", + "up_sell_product_ids": "array", + "cross_sell_products": "array", + "cross_sell_product_ids": "array", + "media_attributes": "array", + "media_attribute_values": "array", + "media_gallery_images": "object{}", + "salable": "bool", + "is_salable": "bool", + "custom_design_date": "array", + "request_path": "string", + "gift_message_available": "string", + "options": "object{}[]", + "preconfigured_values": "object{}", + "identities": "array", + "id": "int", + "quantity_and_stock_status": "array", + "stock_data": "array", + "_origData": "array", + "_isNew": "boolean" + }, + "catalog_product_save_commit_after": { + "store_id": "int", + "name": "string", + "price": "float", + "visibility": "int", + "attribute_set_id": "int", + "created_at": "string", + "updated_at": "string", + "type_id": "array", + "status": "int", + "category_id": "int", + "category": "object{}", + "category_ids": "array", + "website_ids": "array", + "store_ids": "array", + "qty": "float", + "data_changed": "bool", + "calculated_final_price": "float", + "minimal_price": "float", + "special_price": "float", + "special_from_date": "mixed", + "special_to_date": "mixed", + "related_products": "array", + "related_product_ids": "array", + "up_sell_products": "array", + "up_sell_product_ids": "array", + "cross_sell_products": "array", + "cross_sell_product_ids": "array", + "media_attributes": "array", + "media_attribute_values": "array", + "media_gallery_images": "object{}", + "salable": "bool", + "is_salable": "bool", + "custom_design_date": "array", + "request_path": "string", + "gift_message_available": "string", + "options": "object{}[]", + "preconfigured_values": "object{}", + "identities": "array", + "id": "int", + "quantity_and_stock_status": "array", + "stock_data": "array", + "_origData": "array", + "_isNew": "boolean" + }, + "catalog_product_delete_commit_after": { + "store_id": "int", + "name": "string", + "price": "float", + "visibility": "int", + "attribute_set_id": "int", + "created_at": "string", + "updated_at": "string", + "type_id": "array", + "status": "int", + "category_id": "int", + "category": "object{}", + "category_ids": "array", + "website_ids": "array", + "store_ids": "array", + "qty": "float", + "data_changed": "bool", + "calculated_final_price": "float", + "minimal_price": "float", + "special_price": "float", + "special_from_date": "mixed", + "special_to_date": "mixed", + "related_products": "array", + "related_product_ids": "array", + "up_sell_products": "array", + "up_sell_product_ids": "array", + "cross_sell_products": "array", + "cross_sell_product_ids": "array", + "media_attributes": "array", + "media_attribute_values": "array", + "media_gallery_images": "object{}", + "salable": "bool", + "is_salable": "bool", + "custom_design_date": "array", + "request_path": "string", + "gift_message_available": "string", + "options": "object{}[]", + "preconfigured_values": "object{}", + "identities": "array", + "id": "int", + "quantity_and_stock_status": "array", + "stock_data": "array", + "_origData": "array", + "_isNew": "boolean" + }, + "cataloginventory_stock_item_save_commit_after": { + "item_id": "int", + "website_id": "int", + "stock_id": "int", + "product_id": "int", + "stock_status_changed_auto": "bool", + "qty": "float", + "is_in_stock": "bool", + "is_qty_decimal": "bool", + "is_decimal_divided": "bool", + "low_stock_date": "string", + "use_config_min_qty": "bool", + "min_qty": "float", + "use_config_min_sale_qty": "bool", + "min_sale_qty": "float", + "use_config_max_sale_qty": "bool", + "max_sale_qty": "float", + "use_config_notify_stock_qty": "bool", + "notify_stock_qty": "float", + "use_config_enable_qty_inc": "bool", + "enable_qty_increments": "bool", + "use_config_qty_increments": "bool", + "qty_increments": "int", + "use_config_backorders": "bool", + "backorders": "int", + "use_config_manage_stock": "bool", + "manage_stock": "int", + "_origData": "array", + "_isNew": "boolean" + }, + "sales_order_invoice_save_after": { + "items": "object{}[]", + "comments": "object{}[]", + "increment_id": "string", + "base_total_refunded": "float", + "discount_description": "string", + "base_currency_code": "string", + "base_discount_amount": "float", + "base_grand_total": "float", + "base_discount_tax_compensation_amount": "float", + "base_shipping_amount": "float", + "base_shipping_discount_tax_compensation_amnt": "float", + "base_shipping_incl_tax": "float", + "base_shipping_tax_amount": "float", + "base_subtotal": "float", + "base_subtotal_incl_tax": "float", + "base_tax_amount": "float", + "base_to_global_rate": "float", + "base_to_order_rate": "float", + "billing_address_id": "int", + "can_void_flag": "int", + "created_at": "string", + "discount_amount": "float", + "email_sent": "int", + "global_currency_code": "string", + "grand_total": "float", + "discount_tax_compensation_amount": "float", + "is_used_for_refund": "int", + "order_currency_code": "string", + "order_id": "int", + "shipping_address_id": "int", + "shipping_amount": "float", + "shipping_discount_tax_compensation_amount": "float", + "shipping_incl_tax": "float", + "shipping_tax_amount": "float", + "state": "int", + "store_currency_code": "string", + "store_id": "int", + "store_to_base_rate": "float", + "store_to_order_rate": "float", + "subtotal": "float", + "subtotal_incl_tax": "float", + "tax_amount": "float", + "total_qty": "float", + "transaction_id": "string", + "updated_at": "string", + "_origData": "array", + "_isNew": "boolean" + }, + "sales_order_save_after": { + "payment": "object{}", + "tracking_numbers": "array", + "real_order_id": "string", + "increment_id": "string", + "items": "object{}[]", + "addresses": "object{}[]", + "status_histories": "object{}[]", + "adjustment_negative": "float", + "adjustment_positive": "float", + "applied_rule_ids": "string", + "base_adjustment_negative": "float", + "base_adjustment_positive": "float", + "base_currency_code": "string", + "base_discount_amount": "float", + "base_discount_canceled": "float", + "base_discount_invoiced": "float", + "base_discount_refunded": "float", + "base_grand_total": "float", + "base_discount_tax_compensation_amount": "float", + "base_discount_tax_compensation_invoiced": "float", + "base_discount_tax_compensation_refunded": "float", + "base_shipping_amount": "float", + "base_shipping_canceled": "float", + "base_shipping_discount_amount": "float", + "base_shipping_discount_tax_compensation_amnt": "float", + "base_shipping_incl_tax": "float", + "base_shipping_invoiced": "float", + "base_shipping_refunded": "float", + "base_shipping_tax_amount": "float", + "base_shipping_tax_refunded": "float", + "base_subtotal": "float", + "base_subtotal_canceled": "float", + "base_subtotal_incl_tax": "float", + "base_subtotal_invoiced": "float", + "base_subtotal_refunded": "float", + "base_tax_amount": "float", + "base_tax_canceled": "float", + "base_tax_invoiced": "float", + "base_tax_refunded": "float", + "base_total_canceled": "float", + "base_total_invoiced": "float", + "base_total_invoiced_cost": "float", + "base_total_offline_refunded": "float", + "base_total_online_refunded": "float", + "base_total_paid": "float", + "base_total_qty_ordered": "float", + "base_total_refunded": "float", + "base_to_global_rate": "float", + "base_to_order_rate": "float", + "billing_address_id": "int", + "can_ship_partially": "int", + "can_ship_partially_item": "int", + "coupon_code": "string", + "created_at": "string", + "customer_dob": "string", + "customer_email": "string", + "customer_firstname": "string", + "customer_gender": "int", + "customer_group_id": "int", + "customer_id": "int", + "customer_is_guest": "int", + "customer_lastname": "string", + "customer_middlename": "string", + "customer_note": "string", + "customer_note_notify": "int", + "customer_prefix": "string", + "customer_suffix": "string", + "customer_taxvat": "string", + "discount_amount": "float", + "discount_canceled": "float", + "discount_description": "string", + "discount_invoiced": "float", + "discount_refunded": "float", + "edit_increment": "int", + "email_sent": "int", + "ext_customer_id": "string", + "ext_order_id": "string", + "forced_shipment_with_invoice": "int", + "global_currency_code": "string", + "grand_total": "float", + "discount_tax_compensation_amount": "float", + "discount_tax_compensation_invoiced": "float", + "discount_tax_compensation_refunded": "float", + "hold_before_state": "string", + "hold_before_status": "string", + "is_virtual": "int", + "order_currency_code": "string", + "original_increment_id": "string", + "payment_authorization_amount": "float", + "payment_auth_expiration": "int", + "protect_code": "string", + "quote_address_id": "int", + "quote_id": "int", + "relation_child_id": "string", + "relation_child_real_id": "string", + "relation_parent_id": "string", + "relation_parent_real_id": "string", + "remote_ip": "string", + "shipping_amount": "float", + "shipping_canceled": "float", + "shipping_description": "string", + "shipping_discount_amount": "float", + "shipping_discount_tax_compensation_amount": "float", + "shipping_incl_tax": "float", + "shipping_invoiced": "float", + "shipping_refunded": "float", + "shipping_tax_amount": "float", + "shipping_tax_refunded": "float", + "state": "string", + "status": "string", + "store_currency_code": "string", + "store_id": "int", + "store_name": "string", + "store_to_base_rate": "float", + "store_to_order_rate": "float", + "subtotal": "float", + "subtotal_canceled": "float", + "subtotal_incl_tax": "float", + "subtotal_invoiced": "float", + "subtotal_refunded": "float", + "tax_amount": "float", + "tax_canceled": "float", + "tax_invoiced": "float", + "tax_refunded": "float", + "total_canceled": "float", + "total_invoiced": "float", + "total_item_count": "int", + "total_offline_refunded": "float", + "total_online_refunded": "float", + "total_paid": "float", + "total_qty_ordered": "float", + "total_refunded": "float", + "updated_at": "string", + "weight": "float", + "x_forwarded_for": "string", + "_origData": "array", + "_isNew": "boolean", + "custom_attributes": [ + { + "attribute_code": "string", + "value": "mixed" + } + ] + }, + "sales_order_save_commit_after": { + "payment": "object{}", + "tracking_numbers": "array", + "real_order_id": "string", + "increment_id": "string", + "items": "object{}[]", + "addresses": "object{}[]", + "status_histories": "object{}[]", + "adjustment_negative": "float", + "adjustment_positive": "float", + "applied_rule_ids": "string", + "base_adjustment_negative": "float", + "base_adjustment_positive": "float", + "base_currency_code": "string", + "base_discount_amount": "float", + "base_discount_canceled": "float", + "base_discount_invoiced": "float", + "base_discount_refunded": "float", + "base_grand_total": "float", + "base_discount_tax_compensation_amount": "float", + "base_discount_tax_compensation_invoiced": "float", + "base_discount_tax_compensation_refunded": "float", + "base_shipping_amount": "float", + "base_shipping_canceled": "float", + "base_shipping_discount_amount": "float", + "base_shipping_discount_tax_compensation_amnt": "float", + "base_shipping_incl_tax": "float", + "base_shipping_invoiced": "float", + "base_shipping_refunded": "float", + "base_shipping_tax_amount": "float", + "base_shipping_tax_refunded": "float", + "base_subtotal": "float", + "base_subtotal_canceled": "float", + "base_subtotal_incl_tax": "float", + "base_subtotal_invoiced": "float", + "base_subtotal_refunded": "float", + "base_tax_amount": "float", + "base_tax_canceled": "float", + "base_tax_invoiced": "float", + "base_tax_refunded": "float", + "base_total_canceled": "float", + "base_total_invoiced": "float", + "base_total_invoiced_cost": "float", + "base_total_offline_refunded": "float", + "base_total_online_refunded": "float", + "base_total_paid": "float", + "base_total_qty_ordered": "float", + "base_total_refunded": "float", + "base_to_global_rate": "float", + "base_to_order_rate": "float", + "billing_address_id": "int", + "can_ship_partially": "int", + "can_ship_partially_item": "int", + "coupon_code": "string", + "created_at": "string", + "customer_dob": "string", + "customer_email": "string", + "customer_firstname": "string", + "customer_gender": "int", + "customer_group_id": "int", + "customer_id": "int", + "customer_is_guest": "int", + "customer_lastname": "string", + "customer_middlename": "string", + "customer_note": "string", + "customer_note_notify": "int", + "customer_prefix": "string", + "customer_suffix": "string", + "customer_taxvat": "string", + "discount_amount": "float", + "discount_canceled": "float", + "discount_description": "string", + "discount_invoiced": "float", + "discount_refunded": "float", + "edit_increment": "int", + "email_sent": "int", + "ext_customer_id": "string", + "ext_order_id": "string", + "forced_shipment_with_invoice": "int", + "global_currency_code": "string", + "grand_total": "float", + "discount_tax_compensation_amount": "float", + "discount_tax_compensation_invoiced": "float", + "discount_tax_compensation_refunded": "float", + "hold_before_state": "string", + "hold_before_status": "string", + "is_virtual": "int", + "order_currency_code": "string", + "original_increment_id": "string", + "payment_authorization_amount": "float", + "payment_auth_expiration": "int", + "protect_code": "string", + "quote_address_id": "int", + "quote_id": "int", + "relation_child_id": "string", + "relation_child_real_id": "string", + "relation_parent_id": "string", + "relation_parent_real_id": "string", + "remote_ip": "string", + "shipping_amount": "float", + "shipping_canceled": "float", + "shipping_description": "string", + "shipping_discount_amount": "float", + "shipping_discount_tax_compensation_amount": "float", + "shipping_incl_tax": "float", + "shipping_invoiced": "float", + "shipping_refunded": "float", + "shipping_tax_amount": "float", + "shipping_tax_refunded": "float", + "state": "string", + "status": "string", + "store_currency_code": "string", + "store_id": "int", + "store_name": "string", + "store_to_base_rate": "float", + "store_to_order_rate": "float", + "subtotal": "float", + "subtotal_canceled": "float", + "subtotal_incl_tax": "float", + "subtotal_invoiced": "float", + "subtotal_refunded": "float", + "tax_amount": "float", + "tax_canceled": "float", + "tax_invoiced": "float", + "tax_refunded": "float", + "total_canceled": "float", + "total_invoiced": "float", + "total_item_count": "int", + "total_offline_refunded": "float", + "total_online_refunded": "float", + "total_paid": "float", + "total_qty_ordered": "float", + "total_refunded": "float", + "updated_at": "string", + "weight": "float", + "x_forwarded_for": "string", + "_origData": "array", + "_isNew": "boolean", + "custom_attributes": [ + { + "attribute_code": "string", + "value": "mixed" + } + ] + }, + "sales_order_shipment_save_after": { + "shipping_label": "mixed", + "increment_id": "string", + "packages": "string", + "items": "object{}[]", + "tracks": "object{}[]", + "billing_address_id": "int", + "created_at": "string", + "customer_id": "int", + "email_sent": "int", + "order_id": "int", + "shipment_status": "int", + "shipping_address_id": "int", + "store_id": "int", + "total_qty": "float", + "total_weight": "float", + "updated_at": "string", + "comments": "object{}[]", + "_origData": "array", + "_isNew": "boolean" + }, + "sales_order_shipment_track_save_after": { + "number": "string", + "track_number": "string", + "carrier_code": "string", + "created_at": "string", + "description": "string", + "order_id": "int", + "parent_id": "int", + "qty": "float", + "title": "string", + "updated_at": "string", + "weight": "float", + "_origData": "array", + "_isNew": "boolean" + }, + "sales_order_creditmemo_save_after": { + "invoice": "object{}", + "increment_id": "string", + "items": "object{}[]", + "comments": "object{}[]", + "discount_description": "string", + "adjustment": "float", + "adjustment_negative": "float", + "adjustment_positive": "float", + "base_adjustment": "float", + "base_adjustment_negative": "float", + "base_adjustment_positive": "float", + "base_currency_code": "string", + "base_discount_amount": "float", + "base_grand_total": "float", + "base_discount_tax_compensation_amount": "float", + "base_shipping_amount": "float", + "base_shipping_discount_tax_compensation_amnt": "float", + "base_shipping_incl_tax": "float", + "base_shipping_tax_amount": "float", + "base_subtotal": "float", + "base_subtotal_incl_tax": "float", + "base_tax_amount": "float", + "base_to_global_rate": "float", + "base_to_order_rate": "float", + "billing_address_id": "int", + "created_at": "string", + "creditmemo_status": "int", + "discount_amount": "float", + "email_sent": "int", + "global_currency_code": "string", + "grand_total": "float", + "discount_tax_compensation_amount": "float", + "invoice_id": "int", + "order_currency_code": "string", + "order_id": "int", + "shipping_address_id": "int", + "shipping_amount": "float", + "shipping_discount_tax_compensation_amount": "float", + "shipping_incl_tax": "float", + "shipping_tax_amount": "float", + "state": "int", + "store_currency_code": "string", + "store_id": "int", + "store_to_base_rate": "float", + "store_to_order_rate": "float", + "subtotal": "float", + "subtotal_incl_tax": "float", + "tax_amount": "float", + "transaction_id": "string", + "updated_at": "string", + "_origData": "array", + "_isNew": "boolean", + "custom_attributes": [ + { + "attribute_code": "string", + "value": "mixed" + } + ] + }, + "sales_order_status_history_save_after": { + "comment": "string", + "created_at": "string", + "entity_id": "int", + "entity_name": "string", + "is_customer_notified": "int", + "is_visible_on_front": "int", + "parent_id": "int", + "status": "string", + "_origData": "array", + "_isNew": "boolean" + }, + "sales_quote_save_after": { + "currency": "object{}", + "items": "object{}[]", + "created_at": "string", + "updated_at": "string", + "converted_at": "string", + "is_active": "bool", + "items_count": "int", + "items_qty": "float", + "orig_order_id": "int", + "reserved_order_id": "string", + "customer_is_guest": "bool", + "customer_note": "string", + "customer_note_notify": "bool", + "store_id": "int", + "shared_store_ids": "array", + "customer_group_id": "int", + "customer_tax_class_id": "int", + "items_summary_qty": "int", + "item_virtual_qty": "int", + "totals": "object{}[]", + "messages": "array", + "_origData": "array", + "_isNew": "boolean" + }, + "salesrule_rule_save_after": { + "customer_group_ids": "array", + "store_labels": "array", + "from_date": "string", + "simple_action": "string", + "to_date": "string", + "_origData": "array", + "_isNew": "boolean" + }, + "salesrule_rule_delete_after": { + "customer_group_ids": "array", + "store_labels": "array", + "from_date": "string", + "simple_action": "string", + "to_date": "string", + "_origData": "array", + "_isNew": "boolean" + } +} diff --git a/README.md b/README.md index 324ea2fb..86b226e7 100644 --- a/README.md +++ b/README.md @@ -320,6 +320,9 @@ Here are the events with the minimal required fields you need to subscribe to, i | Order | observer.sales_order_save_commit_after | created_at, updated_at | order update ([hold](https://adobe-commerce.redoc.ly/2.4.6-admin/tag/ordersidhold#operation/PostV1OrdersIdHold), [unhold](https://adobe-commerce.redoc.ly/2.4.6-admin/tag/ordersidunhold#operation/PostV1OrdersIdUnhold), [cancel](https://adobe-commerce.redoc.ly/2.4.6-admin/tag/ordersidcancel#operation/PostV1OrdersIdCancel), [emails](https://adobe-commerce.redoc.ly/2.4.6-admin/tag/ordersidemails#operation/PostV1OrdersIdEmails)) | | Stock | observer.cataloginventory_stock_item_save_commit_after | product_id | product [stock update](https://adobe-commerce.redoc.ly/2.4.6-admin/tag/productsproductSkustockItemsitemId/#operation/PutV1ProductsProductSkuStockItemsItemId) | +> [!NOTE] +> For the complete schema of each event, including all available fields and their types, refer to [`EVENTS_SCHEMA.json`](./EVENTS_SCHEMA.json) in the root of this repository. + ### Automating the execution of onboarding and event subscription App builder defines lifecycle event hooks that make possible to automatically execute custom code when a particular application lifecycle event happens. @@ -746,6 +749,9 @@ You can find more details about unit testing and an example in [Lesson 3: Testin The starter kit comes with predefined events for each entity. Sometimes, you may need to add a new event to an entity, e.g., a customer. To do this, follow the next steps: +> [!TIP] +> Before adding a new event, check [`EVENTS_SCHEMA.json`](./EVENTS_SCHEMA.json) to understand the schema structure and available fields for similar events. This will help you properly handle the event payload in your action handlers. + - Add the event to the `./onboarding/config/events.json` file under the related entity flow; for example, if the event is related to a customer and is coming from commerce, you should add it under entity customer -> commerce. e.g., ```json "customer": {