1. Embedded SDK
Salla Platform Docs
  • Embedded SDK
    • Overview
    • Getting Started
    • Create an Embedded App
    • Authentication
    • App Design Guidelines
    • Installation
    • Playground
  • Auth Module
    • Get Token
    • Client Introspect
    • Refresh Token
  • Page Module
    • External Redirects
    • Navigation
    • Set Page Title
  • Nav Module
    • Create Navbar Action
    • Listen for Navbar Actions
    • Clearing Navbar Actions
    • Add Navbar Item
    • Update Navbar Item
    • Listen for Navbar Item Click
    • Remove Navbar Item
  • UI Module
    • Confirm Dialogs
    • Toast Notifications
    • Loading States
    • Breadcrumbs
  • Checkout Module
    • Create Checkout
    • Get App Add-ons
    • Subscribe for Payment Result
  • Endpoints
    • Token Introspect
      POST
  • Resources
    • Support
    • Common Examples
  • Report Builder
    • Overview
    • Getting Started
    • JMESPath Tutorial
    • Understanding the Report Lifecycle
    • Salla Reports Examples
    • Set up Store data using merchant APIs
    • Report Types
      • Unit
      • Bar
      • Breakdown
      • Calendar
      • Distribution
      • Pipe
      • Plot
      • Ranking
      • Summary
      • Agrid
    • APIs
      • Token Introspect
  • App Onboarding
    • Overview
    • Get Started
    • Interfaces and Responses
    • Example
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Embedded SDK

Create an Embedded App

To integrate your application into the Salla Merchant Dashboard, you need to register it in the Salla Partner Portal and configure your embedded pages.

What you'll learn:#

Configure Your App
How Salla Loads Your App
URL Parameters

Configure Your App#

Step 1: Access the Partners Portal#

1.
Log in to your Salla Partners Portal account.
2.
Select your app from the My Apps section.
3.
Navigate to the Embedded Pages section.
Embedded Pages section

Step 2: Configure an Embedded Page#

When adding a new embedded page, you will need to provide the following details:
Adding a new embedded page
1
Route Slug
Define a unique path for your page within the dashboard (e.g., my-app). This will appear in the URL as https://s.salla.sa/embedded/app/{appId}/my-app.
2
Iframe URL
The full URL where your application is hosted (e.g., https://dashboard.myapp.net/salla/embedded).
Note: Salla will append authentication and layout parameters to this URL (e.g., ?token=XXX&theme=dark), as explained in Authentication.
3
Default Page
Toggle this option if you want this page to be the primary landing view when a merchant opens your app.
Embedded page added
Embedded App Banner
It is imperative to add Embedded App Banner image with 1420×520 px in your App Card for a smooth App publishing journey.
On the Partners Portal, go to My Apps -> Select the App-> App Details -> Start publishing your App-> App Features -> Embedded App Banner.
image.png

How Salla Loads Your App#

1.
The merchant opens the installed app from the Salla dashboard.
2.
The app view renders and displays the "Use App" button.
3.
When the merchant clicks "Use App", Salla loads your app’s configured Embedded Page inside an iframe.
4.
The embedded page establishes a communication bridge using the Embedded SDK.
5.
The embedded app initializes and renders its user interface.
Installed app view

URL Parameters#

Salla automatically appends several query parameters to your URL to help with the initial render:
token: A short-lived authentication token.
theme: The merchant's current theme (light or dark).
lang: The merchant's preferred language (ar or en).
Embedded App Preview

Next Steps#

Install the SDK
Add the SDK to your project via NPM or CDN to initialize your app.
Setup Authentication
Securely verify session tokens using the Salla Introspection API.
Modified at 2026-05-17 14:02:50
Previous
Getting Started
Next
Authentication