1. App Onboarding
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. App Onboarding

Example

In this step example, your App asks the Merchant to enter their credentials (Email and Password). We will validate two fields: email and password.

The Validation Logic#

1.
Fields Validation:
Ensure the merchant has entered a valid email and password.
2.
Logic Constraint:
If the merchant enters an invalid email or password, prompt them to re-enter the incorrect field.

Implementation Example#

In the following sections we provided a step-by-step guide to add an onboarding step to get the Merchant credentials upon installation.

Prerequisites#

Before you begin, make sure you have:
1
Create a Salla Partner Account
If you don’t already have a partner account, Sign up here
2
Create Your App
Create a new app inside the Salla Partner Portal
3
Install on a Demo Store
Install your App on a demo store to test its functionality and configuration

Partners Portal#

In the Partners Portal, open the App Details page, scroll down to the App Onboarding section, and click Create Onboarding Step.
Create Onboarding Step
Then fill in the details. In this example, we will add a welcome step requesting the merchant’s email address and password.
Welcome Step Setup
After adding the step, click the three dots next to the step and select Edit Form Settings.
Edit Form Settings
Then select the required fields as shown below.
Select Fields
Note
The unique id for each field is critical and will be used to show error messages or get the form data
Click the Save button to apply the changes.
After that, return to the App Onboarding Steps section, click the three dots again, and choose Edit Function.
Edit Function Option
On the Edit Function page, you will see a preview of the form you previously created.
Form Preview
You can select the demo store to test the steps.
Select Demo Store
Enter the required fields for the onboarding step.
Enter Fields
Click the Preview button to see the results.
The results will appear as shown below.
Preview Results
Note
The onboarding step checks user input in real time. If something is invalid, an error message appears directly under the field with clear instructions on how to fix it.
Validation should run quickly to keep the process smooth and prevent delays or long loading states.

Edit Function Code#

The function code below allows you to validate the email and password and return appropriate error or success messages.

Technical Breakdown of Personalization Fields#

Field KeyUX PurposeValidation Focus
EmailServes as the unique user identifier for account creation, login, and personalized content retrieval (e.g., saved dashboards, templates, preferences).Format validation (valid email structure), presence check (not empty), and uniqueness check (not already registered).
PasswordSecures user access to personalized data and settings within the app.Strength validation (minimum length, character requirements), presence check, and secure storage compliance (hashed & encrypted).

UX Enhancements#

Contextual Feedback: By using .setFields(), the error message appears directly under the relevant field, making it clear and actionable for the merchant.
Immediate Value: The success() block can trigger a personalized dashboard experience — creating an “Aha!” moment that demonstrates the value of completing onboarding.

Merchant Preview#

To view the onboarding steps from the Merchant side, install the app on a demo store linked to your partner account.
On the App Details page, scroll down to the App Testing section and click Install App next to the demo store.
Install App
You will then be redirected to the onboarding page.
Onboarding Page

Success Response Example#

After the merchant enter the email and password correctly, a success message will appear and the App will be installed.

Error Response Example#

In the case where the Merchants leaves the Email field blank an error message (Which we set in the function code) will appear on the upper right corner.
Modified at 2026-05-10 20:40:55
Previous
Interfaces and Responses