Skip to main content
Version: 3.x

Manifest

The manifest definition.

type Manifest {
  identifier: String!
  version: String!
  name: String!
  about: String
  permissions: [Permission!]
  appUrl: String
  configurationUrl: String @deprecated
  tokenTargetUrl: String
  dataPrivacy: String @deprecated
  dataPrivacyUrl: String
  homepageUrl: String
  supportUrl: String
  extensions: [AppManifestExtension!]!
  webhooks: [AppManifestWebhook!]!
  audience: String
  requiredSaleorVersion: AppManifestRequiredSaleorVersion
  author: String
  brand: AppManifestBrand
}
Expand ▼

Fields​

Manifest.identifier ● String! non-null scalar​

The identifier of the manifest for the app.

Manifest.version ● String! non-null scalar​

The version of the manifest for the app.

Manifest.name ● String! non-null scalar​

The name of the manifest for the app .

Manifest.about ● String scalar​

Description of the app displayed in the dashboard.

Manifest.permissions ● [Permission!] list object​

The array permissions required for the app.

Manifest.appUrl ● String scalar​

App website rendered in the dashboard.

Manifest.configurationUrl ● String deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0. Use appUrl instead.

URL to iframe with the configuration for the app.

Manifest.tokenTargetUrl ● String scalar​

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

Manifest.dataPrivacy ● String deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0. Use dataPrivacyUrl instead.

Description of the data privacy defined for this app.

Manifest.dataPrivacyUrl ● String scalar​

URL to the full privacy policy.

Manifest.homepageUrl ● String scalar​

External URL to the app homepage.

Manifest.supportUrl ● String scalar​

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

Manifest.extensions ● [AppManifestExtension!]! non-null object​

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

Manifest.webhooks ● [AppManifestWebhook!]! non-null object​

List of the app's webhooks.

Added in Saleor 3.5

Manifest.audience ● String scalar​

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

Added in Saleor 3.8

Manifest.requiredSaleorVersion ● AppManifestRequiredSaleorVersion object​

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

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.

Manifest.author ● String scalar​

The App's author name.

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.

Manifest.brand ● AppManifestBrand object​

App's brand data.

Added in Saleor 3.14
This API is currently in Feature Preview and can be subject to changes at later point.

Member of​

AppFetchManifest object

Was this page helpful?