Event & Payload Reference

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.

Event	Fires when	Controlled by Supported Feature
`communication.sms.send`	Salla needs to send an SMS to a customer	Local SMS and/or International SMS
`communication.email.send`	Salla needs to send an email to a customer	Email
`communication.whatsapp.send`	Salla needs to send a WhatsApp message to a customer	WhatsApp

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": ["[email protected]"],
    "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 Type	Description	API Reference
`order`	A unique identifier for a store order.	Order API
`shipment`	A unique identifier for a shipment.	Shipment API
`cart`	A unique identifier for a shopping cart.	Abandoned Cart API
`feedback`	A unique identifier for a customer review.	Review API
`product`	A unique identifier for a product.	Product API
`repurchase_reminder`	A merchant-configured repurchase reminder.	— (no public fetch endpoint; use the pre-composed `content`)

Available events#

Payload Schema (CommunicationEvent)#

Event Reference#

Entity Type Reference#

Available events

Payload Schema (`CommunicationEvent`)

Event Reference

Entity Type Reference