Create Onboarding Steps

Follow these steps to build and integrate a custom onboarding steps for your App within the Salla Partners Portal.

Prerequisites

Before you begin, make sure you have:

Create a Salla Partner Account

If you don’t already have a partner account, Sign up here

Create Your App

Create a new app inside the Salla Partner Portal

Install on a Demo Store

Install your App on a demo store to test its functionality and configuration

Create a New Onboarding Step

To begin building your steps, on the App details page, scroll down to the App Onboarding Steps section and click the Create Onboarding Step button.

A configuration form will appear.

Use the table below to define each element of your onboarding step:

Field	Description
Step Icon	A visual indicator representing the configuration type (e.g., a "Key" icon for API setup or a "Sliders" icon for general preferences).
Step Label	The primary title of the configuration step. Use clear, descriptive labels (e.g., Authorize API Integration or Set Default Language).
Slug	A unique system key (e.g., `api_auth_step`).
Required Step	A toggle to designate a step as "Required." Enabling this prevents the merchant from activating the app until the configuration is saved.
Add Step	Once the configuration parameters are set, click Add to commit this step to the onboarding flow.

Great! You have just added the first step in your App onboarding steps.

Configuring Step Fields & Data Handling

Edit Form Settings

After creating a step, you must define the specific input fields that the merchant will interact with. This data will be passed to a function created in the next step.

This option allows you to build and edit a form for this step. Select the fields you want to add to the form and edit each field as needed.

Learn more about editing fields in this article.

Edit Function

The function editor allows you to modify the functions required by the app. You can also use our endpoints to fetch relevant data. Authentication code will be injected automatically.

The function editor will be displayed with a preview of the form previously created.

Next, choose one of the demo stores connected to the app to test the function.
Read more about demo stores here

After that, click Preview to begin testing.

You will receive the response results in this window.

When a merchant completes an onboarding step, Salla triggers an event that sends a structured payload to your application's defined function. Use the provided interface to map the incoming data to your backend logic.

Create Onboarding Steps

Prerequisites#

Create a New Onboarding Step#

Configuring Step Fields & Data Handling#

Edit Form Settings#

Edit Function#

Prerequisites

Create a New Onboarding Step

Configuring Step Fields & Data Handling

Edit Form Settings

Edit Function