A private app is an application created for one specific Zid store. It is not listed publicly in Zid App Market and can only be activated by the merchant of the store assigned to the app.
Private apps can now be created and activated through a self-service flow. You do not need to upload a contract, submit the app for Zid review, or wait for Zid to install or activate it.
Create a private app
To create a private app:
Open the Partner Dashboard.
Go to All Apps.
Click Create Application.
Select Private as the application type.
Enter the required technical information:
Application Name (Arabic)
Application Name (English)
Application URL
Maintainer Email
Application Scopes
Enter the Store ID of the merchant who will use the app.
Complete the application creation.
Note: A private app can be connected to only one store. The system validates that the Store ID exists and that the store is not already linked to the private app.
Store eligibility
The target store must have access to the Private Connection feature. If the merchant's current plan does not include Private Connection, you can still create the private app. After creation, you will receive an add-on purchase link that you can share with the merchant so they can enable Private Connection for their store.
Configure OAuth 2.0
Private apps use the same OAuth 2.0 authentication flow as other Zid applications.
Configure your application's redirect URL and OAuth integration to:
Request permission from the merchant.
Receive the authorization callback.
Receive and refresh access tokens.
For more information, see the Zid Authorization Documentation.
Select application scopes
Select the permissions your app requires from the Application Scopes section.
The merchant will see the requested scopes before activating the app and must approve them as part of the OAuth consent flow.
Private apps do not require Zid to review or approve the selected scopes before activation.
Activate the private app
After the app is created, the Partner Dashboard displays a confirmation indicating that the app has been added and that the merchant must activate it.
You will also receive an activation link.
Share this activation link with the merchant of the Store ID configured for the app.
The activation link works only for the assigned store. Before activation, you can change the target Store ID if needed. After the merchant activates the app, the Store ID can no longer be changed.
How the merchant activates the app
When the merchant opens the activation link, they can review:
Partner name
Application name
Requested scopes
Maintainer email
The merchant then activates the app and completes the standard OAuth consent flow.
Merchant activation acts as the approval for installing and connecting the private app. No additional approval or action from Zid is required.
How to know when the app is activated
There is no separate activation status in the Partner Dashboard.
After the merchant approves the app, the standard OAuth flow redirects to your configured redirect URL and sends the authorization information required to obtain the app tokens.
Receiving the OAuth callback confirms that the merchant has activated the app.
Webhooks
You can configure webhooks while creating the application or later from the application's webhook settings.
For more information, see the Zid technical documentation for Webhooks.
Uninstalling a private app
The existing uninstall behavior remains unchanged.
When the merchant uninstalls the app:
The application's tokens are revoked.
The existing uninstall webhook is triggered.
Frequently asked questions
Frequently asked questions
Can I use one private app for multiple stores?
No. Each private app is connected to one Store ID only.
If you need a private integration for another store, create a separate private app for that store.
Can I change the Store ID?
Yes. You can change the target Store ID until the merchant activates the application.
After activation, the Store ID cannot be changed.
Can another merchant use the activation link?
No. The activation link is bound to the Store ID configured for the private app.
Does Zid need to review or install my private app?
No. Private app creation and activation are self-service.
You do not need to:
Upload a contract.
Submit the private app for Zid review.
Contact Zid to install the app.
Wait for Zid to activate it.
The merchant activates the app directly using the activation link you provide.