Skip to main content

Create a public app

This article summarizes the required steps to create your App on the App Market.

To create a new application, follow these steps:

  1. Open the dashboard

  2. Navigate to My Apps

  3. Click the Create Application button.

  4. Fill in the basic information for your application

    • Application Name: The name of your App that will appear to the merchant."make sure of write App name in Arabic and English Language"

    • Application URL: Your main company website. started with "http://"

    • Application Category: Define your service category.

    • Application Language: Supported languages in the system.

    • Maintainer E-mail: The responsible email to receive and reply to the issues.

  5. Click the Create Application button to move to the next step.

General Settings

This page displays your OAUTH 2.0 and your App ID (Client ID) and Secret key.

Implement OAuth 2.0

  • Redirect url (Ask for merchant permission)

  • Callback Method (Get the tokens)

  • Refresh tokens

    OAUTH 2.0

    If you are not familiar with OAUTH 2.0 or you need more information about OAUTH 2.0, redirection or Callback, please check our Authorization Documentation.

Explore our APIs

Scope Selection

Select the App permissions from the Application scopes section. Check the radio buttons of each App permission that you want to use. When you submit your application to be published, our team will review the selected scopes and notify you.

Embed application

Give merchants the ability to access the app directly from their dashboard, click here to view the documentation.

Example:


​

Custom Snippets

Add custom HTML and JavaScript snippets to stores using your app.
​

Application Details

  1. Application links:

    • Redirection URL, to read more about this URL click here

    • Callback URL: to read more about this URL click here

  2. Application Description:

    • Long Description:

      • App Definition

      • App services

      • App Features

    • Short Description:

      1. Include a brief of your App services.

  3. Developed by: Your main company name will be shown to the merchants in the App page.

  4. Application Video: We support only embedding Youtube video URL with this format: https://www.youtube.com/embed/######

  5. Applications pictures and screenshots: These will be shown and appear to the merchants in your App page

  6. Application Icon: Your App logo.

  7. Application Testing

Download your app on your development store

Webhook Management

The next Step is to add a webhook. through this screen, you can add new webhooks, and delete or edit your added ones. You can perform this action while creating your application, or later.

Webhooks

For more information about webhooks, check our technical references Section

Plans Management

You can add a maximum of four plans to the application with features and description details.

Note: Subscription plans are displayed from the lowest price to the highest price on the app details page, regardless of the order in which they were created.

How Your Subscription Plans Appear in Zid App Market

Subscription plans are displayed as comparison cards directly on the app details page in both the merchant dashboard and public Zid App Market.

Each plan card displays:

  • Plan name

  • Subscription price

  • Billing period

  • Included features

Plans are displayed from the lowest price to the highest price.

Monthly/Yearly Toggle

When an application offers both monthly and yearly subscription plans, merchants can switch between them using a Monthly/Yearly toggle.

A "Save X%" label highlights the savings calculated using the application's cheapest monthly and yearly plans.

Price Sorting

When merchants sort applications by price in the Zid App Market, the system uses each application's cheapest subscription plan to determine its position. App cards also display full subscription prices and billing periods, helping merchants compare pricing before opening an app's details page.

Note: Existing plans automatically appear in the updated layout. Partners are encouraged to review their plan names, pricing, and feature descriptions for accuracy.

Recurring:

You can add a maximum of 4 subscription plans so that ZId merchants can benefit from the features of your application by subscribing to one of the plans.
​

  • Plan Details

    • Plan Name (*)

      • English / عربي: The name of the plan in both English and Arabic.
        ​

    • Duration (*)

      • Defines how long the plan lasts (e.g., monthly, quarterly, yearly).
        ​

    • Description (*)

      • English / عربي: A short explanation of what the plan includes.
        ​

    • Features (*)

      • English / عربي: A list of key benefits or features included in the plan.
        ​

    • Pricing & Trial

      • Price Plan (SAR) (*)

        • Defines the cost of the plan in Saudi Riyals (SAR).

      • Trial Available (Days) (*)

        • Specifies if a free trial is available for this plan and for how many days.
          ​

      • Additional Fees

        1. One-time fees

          A one-time fee is an additional setup or onboarding charge applied when a merchant subscribes to your app for the first time.

          • The fee is charged only once, on the merchant’s first subscription to the app.

          • The fee is not charged again when the subscription renews.

          • Merchants who subscribed before you added a one-time fee are not charged that fee when they renew.

          • Merchants can see the one-time fee amount next to the plan price in the App Market and in their Zid dashboard.
            ​

    • Offers & Discounts

      1. Add Plan Offer

        Allows you to create an offer for the plan (e.g., discount, Buy X get X).​

Usage-Based Subscription

Charge merchants based on their app usage with flexible pay-as-you-go pricing options to suit various strategies.
​

  • Plan Details

    • Plan Name (*)

      • English / عربي: The name of the plan in both English and Arabic.
        ​

    • Description (*)

      • English / عربي: A short explanation of what the plan includes.
        ​

    • Features (*)

      • English / عربي: A list of key benefits or features included in the plan.
        ​

    • Usage Type

      1. Emails

      2. Messages

      3. Calls

      4. Orders

      5. Other
        ​

    • Initial Cost (*)
      Include the integration and setup fee prior to usage-based charges.
      ​

Manage your subscription

To know more about how to manage your subscriptions click here.

  • Subscription Statuses:

  • Subscription Webhooks

  • Subscription Events


Did this answer your question?