Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Recurring Payments API
  • App Functions
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Recurring Payments API
  • App Functions
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. App Functions
  • Welcome 👋
  • What are App Functions?
  • Get Started
  • Supported Events
  • Testing
  • Responses
  • NodeJs Support
  • Merchants Events
    • Brand Events
    • Cart Events
    • Category Events
    • Communication Events
    • Customer Events
    • Invoice Events
    • Review Events
    • Shipment Events
    • Shipping Company Events
    • Shipping Zone Events
    • Special Offer Events
    • Store Branch Events
  • Customers Events
    • Account Events
    • Cart & Checkout Events
    • Product Events
    • Promotion & Coupon Events
    • Wishlist Events
  1. App Functions

Supported Events

App Functions support a wide range of events triggered by merchant and customer activities. This page provides a comprehensive list of all available events you can listen to in your App Functions.

Event Types#

There are two main categories of events:

Merchant Events#

Events triggered by merchant actions in the store dashboard, such as creating products, updating orders, or managing inventory. These can be either:
⚡ Synchronous Actions — Execute immediately, block the user, and must respond in milliseconds (e.g., shipment.creating)
🔄 Asynchronous Events — Process in the background after the operation completes (e.g., order.created)

Customer Events#

Events triggered by customer interactions on the storefront, such as viewing products, adding items to cart, or completing checkout. These are always processed asynchronously.

Merchant Actions & Events#

📦 Orders#

Order-related events are triggered when orders are created, updated, or modified in any way.
Event NameTypeDescription
Order CreatedAsyncTriggered when a new order is created
Order CompletedAsyncTriggered when an order is marked as completed
Order UpdatedAsyncTriggered when any order field is updated
Order Status UpdatedAsyncTriggered when the order status changes
Order CancelledAsyncTriggered when an order is cancelled
Order RefundedAsyncTriggered when an order is refunded
Order DeletedAsyncTriggered when an order is deleted
Order Products UpdatedAsyncTriggered when order items are modified
Order Payment UpdatedAsyncTriggered when payment information is updated
Order Coupon UpdatedAsyncTriggered when a coupon is applied or removed
Order Total Price UpdatedAsyncTriggered when the order total changes
Common Use Cases:
📧 Send order confirmations
🔄 Update external inventory systems
⚙️ Trigger fulfillment workflows
💰 Sync with accounting software
📨 Send custom notifications
View Order Event Schemas →

🛍️ Products#

Product events are triggered when products are created, updated, or their inventory changes.
Event NameTypeDescription
Product AddedAsyncTriggered when a product is added to the store
Product CreatedAsyncTriggered when a new product is created
Product UpdatedAsyncTriggered when product details are modified
Product DeletedAsyncTriggered when a product is deleted
Product AvailableAsyncTriggered when a product becomes available
Product Quantity LowAsyncTriggered when product inventory is low
Common Use Cases:
🔄 Sync products with external catalogs
💰 Update pricing across platforms
📊 Monitor inventory levels
🔔 Trigger restock notifications
🔍 Update search indexes
View Product Event Schemas →

🚚 Shipments#

Shipment events are triggered during the shipping process. Note: Shipment Creating is synchronous and blocks the user - it must respond in milliseconds.
Event NameTypeDescription
Shipment CreatingSync⚠️ Blocks user - Triggered before shipment creation (must respond in < 500ms)
Shipment CreatedAsyncTriggered after a shipment is created
Shipment CancelledAsyncTriggered when a shipment is cancelled
Shipment UpdatedAsyncTriggered when shipment details are updated
Common Use Cases:
⚡ Calculate custom shipping rates (sync - must be fast!)
✔️ Validate shipping addresses (sync - must be fast!)
🏷️ Create labels with shipping carriers (async)
📧 Send tracking notifications (async)
🔄 Update order status (async)
View Shipment Event Schemas →

🌍 Shipping Zones#

Shipping zone events are triggered when shipping zones are configured.
Event NameTypeDescription
Shipping Zone CreatedAsyncTriggered when a new shipping zone is created
Shipping Zone UpdatedAsyncTriggered when a shipping zone is modified
Common Use Cases:
🔄 Sync shipping configurations
🔌 Update external shipping systems
✔️ Validate zone settings
View Shipping Zone Event Schemas →

🚛 Shipping Companies#

Shipping company events are triggered when shipping companies are managed.
Event NameTypeDescription
Shipping Company CreatedAsyncTriggered when a shipping company is added
Shipping Company UpdatedAsyncTriggered when company details are updated
Shipping Company DeletedAsyncTriggered when a shipping company is removed
Common Use Cases:
🔌 Integrate with shipping carriers
🔄 Update shipping options
⚙️ Sync carrier configurations
View Shipping Company Event Schemas →

👤 Customers#

Customer events are triggered when customer accounts are created or modified.
Event NameTypeDescription
Customer CreatedAsyncTriggered when a new customer account is created
Customer UpdatedAsyncTriggered when customer details are updated
Customer LoginAsyncTriggered when a customer logs in
Customer OTP RequestAsyncTriggered when a customer requests an OTP
Common Use Cases:
🔄 Sync customer data with CRM
📧 Send welcome emails
📊 Track login activity
🔐 Implement custom authentication
View Customer Event Schemas →

📂 Categories#

Category events are triggered when product categories are managed.
Event NameTypeDescription
Category CreatedAsyncTriggered when a new category is created
Category UpdatedAsyncTriggered when a category is modified
Common Use Cases:
🔄 Sync category structures
🗂️ Update navigation menus
📋 Organize product catalogs
View Category Event Schemas →

🏷️ Brands#

Brand events are triggered when brands are created, updated, or deleted.
Event NameTypeDescription
Brand CreatedAsyncTriggered when a new brand is created
Brand UpdatedAsyncTriggered when brand details are updated
Brand DeletedAsyncTriggered when a brand is deleted
Common Use Cases:
🔄 Sync brand information
📄 Update brand pages
🖼️ Manage brand assets
View Brand Event Schemas →

🏪 Store#

Store events are triggered when store branches and settings are managed.
Event NameTypeDescription
Store Branch CreatedAsyncTriggered when a new branch is created
Store Branch UpdatedAsyncTriggered when branch details are updated
Store Branch Set DefaultAsyncTriggered when a branch is set as default
Store Branch ActivatedAsyncTriggered when a branch is activated
Store Branch DeletedAsyncTriggered when a branch is deleted
Store Tax CreatedAsyncTriggered when a tax rule is created
Common Use Cases:
🔄 Sync multi-location inventory
⚙️ Update store configurations
💰 Manage tax settings
View Store Event Schemas →

🛒 Cart#

Cart events are triggered when shopping carts are abandoned.
Event NameTypeDescription
Abandoned CartAsyncTriggered when a cart is abandoned
Common Use Cases:
📧 Send cart recovery emails
📊 Track abandonment rates
📢 Trigger remarketing campaigns
View Cart Event Schemas →

🎟️ Coupons#

Coupon events are triggered when discount codes are applied.
Event NameTypeDescription
Coupon AppliedAsyncTriggered when a coupon is successfully applied
Common Use Cases:
📊 Track coupon usage
✔️ Validate coupon rules
📈 Update marketing analytics
View Coupon Event Schemas →

🧾 Invoices#

Invoice events are triggered when invoices are generated.
Event NameTypeDescription
Invoice CreatedAsyncTriggered when an invoice is created
Common Use Cases:
📧 Send invoice notifications
💰 Sync with accounting systems
📄 Generate custom invoices
View Invoice Event Schemas →

🎁 Special Offers#

Special offer events are triggered when promotional offers are managed.
Event NameTypeDescription
Special Offer CreatedAsyncTriggered when a special offer is created
Special Offer UpdatedAsyncTriggered when an offer is modified
Common Use Cases:
🔄 Sync promotional campaigns
📢 Update marketing materials
📊 Track offer performance
View Special Offer Event Schemas →

⭐ Reviews#

Review events are triggered when customers submit product reviews.
Event NameTypeDescription
Review AddedAsyncTriggered when a customer adds a review
Common Use Cases:
🔍 Moderate reviews
📧 Send thank you messages
⭐ Update product ratings
View Review Event Schemas →

Customer E-commerce Events#

Customer events are triggered by storefront interactions and are always processed asynchronously.

🛍️ Product Interactions#

Event NameDescription
Product ViewedCustomer views a product page
Product ClickedCustomer clicks on a product
Product List ViewedCustomer views a product listing page
Product List FilteredCustomer applies filters to product list
Product SharedCustomer shares a product
Product ReviewedCustomer submits a product review
Products SearchedCustomer performs a product search
View Product Interaction Schemas →

🛒 Cart & 💳 Checkout#

Event NameDescription
Product AddedCustomer adds product to cart
Product RemovedCustomer removes product from cart
Cart ViewedCustomer views their cart
Cart UpdatedCart contents or totals change
Checkout StartedCustomer begins checkout
Checkout Step ViewedCustomer views a checkout step
Checkout Step CompletedCustomer completes a checkout step
Payment Info EnteredCustomer enters payment information
Order CompletedCustomer completes an order
View Cart & Checkout Schemas →

🎁 Promotions & Coupons#

Event NameDescription
Promotion ViewedCustomer views a promotion
Promotion ClickedCustomer clicks on a promotion
Coupon EnteredCustomer enters a coupon code
Coupon AppliedCoupon is successfully applied
Coupon DeniedCoupon application is denied
Coupon RemovedCustomer removes a coupon
View Promotion & Coupon Schemas →

❤️ Wishlist#

Event NameDescription
Wishlist Product AddedCustomer adds product to wishlist
Wishlist Product RemovedCustomer removes product from wishlist
Wishlist Product Added to CartCustomer moves wishlist item to cart
View Wishlist Schemas →

👤 User Account#

Event NameDescription
Signed InCustomer signs in
Signed UpCustomer creates an account
Signed OutCustomer signs out
User Profile UpdatedCustomer updates their profile
View User Account Schemas →

Next Steps#

🚀 Quick Start — Create your first App Function
🧪 Testing App Functions — Learn how to test your functions
📚 Salla APIs — Explore Salla API documentation
Modified at 2025-11-09 12:00:09
Previous
Get Started
Next
Testing