Salla Docs
Merchant
Merchant
  • Merchant API
  • Salla OAuth 2.0
  • Merchant Dashboard
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • App Functions
  • Billing System Salla partners
  • Report Builder
  • App Onboarding
  • Communication Apps
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Change Log
Salla CLI
Merchant
Merchant
  • Merchant API
  • Salla OAuth 2.0
  • Merchant Dashboard
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • App Functions
  • Billing System Salla partners
  • Report Builder
  • App Onboarding
  • Communication Apps
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Communication Apps
  • Get Started
  • App Events
  • Create Your First App
  • Root
  • Settlements
    • List Instant Settlements
    • Create Instant Settlement
    • Update Instant Settlement
    • Instant Settlement Details
  • App Details Builder
    • Get Started
    • Components
      • App Information
      • App Features
      • App Reviews
      • App Contact Info
      • App Brands
      • App FAQ
      • App Statistics
  • Settings
    • App Setting Details
    • Update App Settings
  • Subscriptions
    • App Subscription Details
    • Update Subscription Balance
  • Report Creator
    • Overview
    • Getting Started
    • JMESPath Tutorial
    • Salla Reports Examples
    • Understanding the Report Lifecycle
    • Report Types
      • Unit
      • Bar
      • Breakdown
      • Calendar
      • Distribution
      • Pipe
      • Plot
      • Ranking
      • Summary
      • Agrid
  • App Onboarding Steps
    • Overview
    • Get Started
    • Interfaces and Responses
    • Example
  • Communication Apps
    • Overview
    • Get Started
    • Interfaces and Responses
    • Examples
  1. Communication Apps

Interfaces and Responses

What are Communication Apps?
Communication Apps react to events triggered by Salla. Each event delivers a specific context object to your App Function, and your function is expected to return a structured response.
For App Functions fundamentals (execution types, Resp utility, runtime constraints, testing), see the App Functions reference.

Available events#

The events your function receives are controlled by the Supported Features you declared in the Partner Portal.
EventFires whenControlled by Supported Feature
communication.sms.sendSalla needs to send an SMS to a customerLocal SMS and/or International SMS
communication.email.sendSalla needs to send an email to a customerEmail
communication.whatsapp.sendSalla needs to send a WhatsApp message to a customerWhatsApp

Payload Schema (CommunicationEvent)#

TypeScript Interface
JSON Example
This is the full TypeScript shape of the context object your handler receives.

Event Reference#

These are the common event types your app receives through the data.type field.
Feature Requirement
Ensure the relevant features ("Email", "Local SMS", or "WhatsApp") are enabled in the Partners Portal for these events to trigger correctly.
Orders
Customers & Products
Auth & System
Order Status Confirmation
Sent when an order is created and is pending payment.
Type: order.status.confirmation
Supported Channels: Email, SMS, WhatsApp
Entity Type: order
Meta Fields: customer_id (number)
{
  "event": "communication.email.send",
  "data": {
    "notifiable": ["customer@example.com"],
    "type": "order.status.confirmation",
    "content": "We received your order #123. Please complete payment.",
    "entity": { "id": 123, "type": "order" },
    "meta": { "customer_id": 987 }
  }
}
Order Status Updated
Invoice Issued
Digital Product Code
Order Refunded
Create New Order
Gift Order Placed
Payment Reminder

Entity Type Reference#

Use these references to learn how to fetch more details via the Salla API.
Entity TypeDescriptionAPI Reference
orderA unique identifier for a store order.Order API
shipmentA unique identifier for a shipment.Shipment API
cartA unique identifier for a shopping cart.Abandoned Cart API
feedbackA unique identifier for a customer review.Review API
productA unique identifier for a product.Product API
Modified at 2026-03-30 15:09:35
Previous
Get Started
Next
Examples