Using Events on Magento

Get more details about how to send Magento events to Gameball.

Rana ElGharib avatar
Written by Rana ElGharib
Updated over a week ago

Before starting, please read this article to learn more about Gameball events engine:
How does Challenge Event(s) Rule Engine work?

❗️❗️IMPORTANT NOTE:

You can control what events should be sent to Gameball and what should not through Gameball plugin page on your Magento dashboard.

On Magento Dashboard, click Stores > Settings: Configurations > Customers > Gameball

  • Define Which Magento Events to be sent to Gameball.

Available Magento events on Gameball:

Add_to_Cart

This event will be sent to Gameball when your player adds a product to your Magento store cart.

Keys

  • Category: product category of the product added to cart (fashion, electronics, etc.) This will be based on the available categories on your Magento store

  • ID: product ID

  • Manufacturer: product brand/vendor inside this order (Zara, Nike, etc.) This will be based on the available manufacturers on your Magento store

  • Price: Product price

  • Special Price: indicates if this product has a discount applied on it or not

  • Weight: product weight

Remove_From_Cart

This event will be sent to Gameball when your player removes a product from your Magento store cart.

Keys

  • Category: product category of the product/s added to cart (fashion, electronics, etc.) This will be based on the available categories on your Magento store

  • Manufacturer: product brand/vendor inside this order (Zara, Nike, etc.) This will be based on the available manufacturers on your Magento store

  • Price: product price

  • Special Price: indicates if this product has a discount applied on it or not

  • Weight: product weight.

View_Cart

This event will be sent to Gameball when your player views the cart page of your Magento store cart.

Keys

  • Products_count: Number of products inside the cart

  • Total: Total price of all items inside the cart

Place_Order

Description

This event will be sent to Gameball when your player places an order on your platform completely (completely means that the order status is Completed on Magento).

Keys

  • Category: product category of the order (fashion, electronics, etc.) It can be one category or multiple categories based on how many items are in the order. This will also be based on the available categories on your Magento store

  • Discounted: indicates if there is any product in the order has a discount applied or not

  • Amount: total amount

  • Manufacturer: product brand/vendor inside this order (Zara, Nike, etc.) This will be based on the available manufacturers on your Magento store

  • Weight: order weight.

Review

This event will be sent to Gameball when your player writes a review on a product.

Keys

  • Category: product category of the product added to cart (fashion, electronics, etc.) This will be based on the available categories on your Magento store

  • ID: product ID

  • Manufacturer: product brand/vendor inside this order (Zara, Nike, etc.) This will be based on the available manufacturers on your Magento store

  • Weight: product weight

View_Product

Description

This event should be sent when your player views a product page on your Magento store.

Keys

  • Category: product category of the product added to cart (fashion, electronics, etc.) This will be based on the available categories on your Magento store

  • ID: product ID

  • Name: product name

  • Manufacturer: product brand/vendor inside this order (Zara, Nike, etc.) This will be based on the available manufacturers in your Magento store

  • Stock: available stock from this product on your WooCommerce inventory

  • Price: Product price

  • Special Price: indicates if this product has a discount applied on it or not

  • Weight: product weight

All the above events can be used in both the challenges events engine and sending an in-app message.


Did this answer your question?