Skip to content
Saleor
Esc
↑↓navigate↵open⌘Jpreview

Schema: Saleor 3.23.43Download SDLUpgrade guides

On this page

Manifest Object

The manifest definition.

type Manifest {
  identifier: String!
  version: String!
  name: String!
  about: String
  permissions: [Permission!]
  appUrl: String
  configurationUrl: String @deprecated(reason: "Use `appUrl` instead.")
  tokenTargetUrl: String
  dataPrivacy: String @deprecated(reason: "Use `dataPrivacyUrl` instead.")
  dataPrivacyUrl: String
  deprecationReason: String
  homepageUrl: String
  supportUrl: String
  extensions: [AppManifestExtension!]!
  webhooks: [AppManifestWebhook!]!
  audience: String
  requiredSaleorVersion: AppManifestRequiredSaleorVersion
  author: String
  brand: AppManifestBrand
}

Fields

identifier

identifier · String!

The identifier of the manifest for the app.

version

version · String!

The version of the manifest for the app.

name

name · String!

The name of the manifest for the app .

about

about · String

Description of the app displayed in the dashboard.

permissions

permissions · [Permission!]

The array permissions required for the app.

appUrl

appUrl · String

App website rendered in the dashboard.

configurationUrl

configurationUrl · String

URL to iframe with the configuration for the app.

tokenTargetUrl

tokenTargetUrl · String

Endpoint used during process of app installation, see installing an app.

dataPrivacy

dataPrivacy · String

Description of the data privacy defined for this app.

dataPrivacyUrl

dataPrivacyUrl · String

URL to the full privacy policy.

deprecationReason

deprecationReason · String

Reason why the app is deprecated, declared in the manifest. Null when the app is not deprecated. A deprecated app can still be installed and works as usual, but usually means it should not be used anymore.

Added in Saleor 3.23

homepageUrl

homepageUrl · String

External URL to the app homepage.

supportUrl

supportUrl · String

External URL to the page where app users can find support.

extensions

extensions · [AppManifestExtension!]!

List of extensions that will be mounted in Saleor’s dashboard. For details, please see the extension section.

webhooks

webhooks · [AppManifestWebhook!]!

List of the app’s webhooks.

audience

audience · String

The audience that will be included in all JWT tokens for the app.

requiredSaleorVersion

requiredSaleorVersion · AppManifestRequiredSaleorVersion

Determines the app’s required Saleor version as semver range.

author

author · String

The App’s author name.

brand

brand · AppManifestBrand

App’s brand data.

Used by


Schema: Saleor 3.23.43. Download SDL.

Last updated on April 13, 2026

Was this page helpful?