Get Started#
Follow these steps to build a working Communication App that delivers SMS, Email, or WhatsApp messages through your provider.
🚀 Get Started Roadmap#
Prerequisites#
Before you begin, make sure you have:Step 1: Create a Salla Partner Account
If you do not already have a partner account, sign up here.Step 2: Create Your App
Create a new app inside the Salla Partner Portal. When selecting the app type, choose Communication App.Step 3: Install on a Demo Store
Install your app on a demo store so you have real data to test against. After installation, configure your App Settings to collect necessary provider credentials (like API keys) from merchants.Supported Features declare which communication channels your app handles. When a merchant installs your app, it becomes the active handler for every message type you declare - Salla routes all matching messages through your App Function instead of the default provider.Supported Feature is required. Your app cannot go live until at least one feature is selected.
1.
In the Partner Portal, open your app and scroll down to the Supported Feature section.
2.
Click the Supported Feature button to open the feature selector.
3.
Choose a channel tab and tick the features your app will handle:
| Tab | Feature | What your app handles |
|---|
| SMS | Local SMS | All SMS messages to KSA numbers |
| SMS | International SMS | All SMS messages to numbers outside KSA |
| Email | Email | All email messages |
| Whatsapp | Whatsapp | All WhatsApp messages |
You can select multiple features. For example, tick both Local SMS and International SMS if your SMS provider handles both domestic and international delivery. Each feature you select means your app takes full ownership of that message type for every merchant who installs it.
Step 2: Add an App Function#
In the Partner Portal app editor, scroll to App Functions and click Add New Function.The function builder has four sections:Function Name - A descriptive identifier (e.g. sms-delivery-handler)
Action Selector - The event that triggers this function
Code Editor - Where you write the handler logic
Preview Panel - For testing with real demo store data
Select the event#
Click Select Action and choose the channel you want to handle.| Select this action | To handle |
|---|
communication.sms.send | Outgoing SMS messages |
communication.email.send | Outgoing email messages |
communication.whatsapp.send | Outgoing WhatsApp messages |
You can create one function per channel, or a single function and branch on payload.event.
Step 3: App Functions Example#
Once you select an action, the editor pre-populates the function signature. Replace the body with your delivery logic.Minimal SMS handler#
This example sends a simple SMS via a provider using credentials from your app settings.Full examples for all three channels are on the Examples page.
Step 4: Test and validate via preview#
Before publishing, you must test and validate your function with real store data using the preview panel.1.
In the function editor, click Select Store in the preview panel and choose your demo store.
2.
Enter a test value in the preview parameters (for communication events, this is usually a message or customer ID).
Execution status (success or error)
Response data returned by your function
Execution time in milliseconds
Any console.log() output from your code
Error details if the function threw
Verify that settings values are populated. If context.settings is empty, the merchant has not yet filled in the App Settings form on the demo store.
Step 5: Test through Dashboard and Store Functions#
Once the function is working in preview, you should test the end-to-end flow from the merchant's perspective.1.
Log in to your demo store's dashboard via the Partner Portal (click Dashboard on your demo store list).
3.
Locate the Communication apps settings section.
4.
Choose your app as the default handler for the relevant channels (e.g., Local SMS, International SMS).
5. Trigger a message from the store (e.g., by placing an order or manually sending a notification).
6. Verify that the message is delivered via your provider.
Step 6: Publish#
Once your tests pass, publish your function to make it live for merchants.1.
Return to the Partner Portal and open your app dashboard.
2.
Click Publish to make the function live.
3.
Merchants who have your app installed will receive the update automatically.
All edits are saved in sandbox until you publish. Always test thoroughly before publishing to production.
Next steps#
Modified at 2026-03-08 22:24:17
