Skip to main content
The app node covers all configurations for connecting and controlling the WEBSALE APP.
This section defines central app parameters such as the activation status, authentication, notification settings and the associated service accounts. The configuration can be made directly in the Admin Interface under Settings → Shop configuration → “App” group or via the REST API configuration.

​
app* - Basic structure

The basic structure of the app node is shown below: 
{
  "app": {...},
  "googleServiceAccount": {...},
  "instances": {...},
}

​
Parameter overview

ParameterDescription
app
googleServiceAccount
instances

​
app.app - WEBSALE APP configuration

The app node controls the connection and behaviour of the WEBSALE App. Among other things, it specifies whether the app integration is active, how tokens are validated, which shop connection data is used and which data and filter limits apply.

​
Example configuration

{
  "active": false,
  "applicationId": "",
  "enableTokenValidation": true,
  "filterLimits": {
    "maxEmailListSize": 500000,
    "maxZipCodeListSize": 50000,
    "maxZipCodeRangeSize": 5000
  },
  "googleServiceAccount": null,
  "imageFormats": null,
  "notificationSettings": {
    "defaultSettings": {
      "basketReminder": "undefined",
      "birthdayGreetings": "undefined",
      "deliveryNotification": "undefined",
      "news": "undefined",
      "teaser": "undefined"
    },
    "personalizedMessages": {
      "basketReminder": false,
      "birthdayGreetings": false,
      "deliveryNotification": false
    },
    "pushNotificationBatchSize": 500
  },
  "secret": "",
  "v8": null
}

​
Parameter overview

ParameterTypeDescription
activeboolEnables (true) or disables (false) the WEBSALE APP.
Default: false
applicationIdstringUnique identifier of the app (application ID).
enableTokenValidationboolEnables (true) or disables (false) token validation for app access.
Default: true
filterLimitsobjectLimits for app-internal filter functions.
maxEmailListSizeuintMaximum number of email addresses in a filter list.
Default: 500000
maxZipCodeListSizeuintMaximum number of postal codes in a filter list.
Default: 500000
maxZipCodeRangeSizeuintMaximum number of postal code ranges.
Default: 5000
googleServiceAccountassocReference to the configured Google service account (see the app.googleServiceAccount section).
oAuthKey—authentication.googleOAuthKey.FCMKey
scopes—https://www.googleapis.com/auth/firebase.messaging
imageFormatslistDefines the image formats used in the app frontend (multiple assignments via content.imageFormat).
→ content - Catalogue (categories & products)
notificationSettingsobjectSettings for default and personalised push notifications.
defaultSettingsobjectDefault values for notification types (e.g. basket reminder, delivery status) when the app starts.
basketReminderenumEnables (true) or disables (false) the notification for abandoned baskets.
birthdayGreetingsenumEnables (true) or disables (false) the birthday notification.
To send birthday notifications, the recipient must have specified a date of birth.
deliveryNotificationenumDefault for shipping/delivery notifications.
newsenumDefault for newsletter notifications. Values: undefined, enabled, disabled
teaserenumDefault for marketing messages.
personalizedMessagesobjectEnables/disables personalised message types.
basketReminderenumDefault for the reminder of abandoned baskets.
birthdayGreetingsenumDefault for birthday greetings.
deliveryNotificationenumDefault for shipping/delivery notifications.
pushNotificationBatchSizeuintNumber of push messages processed/sent in one batch.
Example: 500
secretstringSecret key for validating tokens used for app communication.
v8objectOptional detailed configuration for the connection to the V8 shop.
osbAuthobjectCredentials for OSB / backend communication of the app.
usernamestringTechnical user name for the OSB / backend connection.
passwordstringPassword for this technical user.
shopIdstringIdentifier of the connected shop in the backend.
shopUrlstringBase URL of the shop used by the app.
shopPasswordstringPassword for the shop connection.
personalizedDataFetchLimituintMaximum number of personalised records that may be loaded per fetch.
Default: 500
voucherCodesFetchLimituintMaximum number of voucher codes that may be loaded per fetch.
Default: 200

​
app.googleServiceAccount - Push messages

The googleServiceAccount node defines the connection to a Google service account, for example for sending push messages.

​
Example configuration

{
  "oAuthKey": "authentication.googleOAuthKey.FCMKey",
  "scopes": [
    "https://www.googleapis.com/auth/firebase.messaging"
  ]
}

​
Parameter overview

ParameterTypeDescription
oAuthKeysingleAssocReferences a stored Google OAuth key that contains the credentials (key/JSON) of the service account.
Target: authentication.googleOAuthKey
scopeslist (string)List of OAuth scopes requested for the service account.

​
app.instances - APP instances

The instances node defines individual app instances of the WEBSALE App, typically per country, brand or channel. For each instance you can configure, among other things, base URLs, country information and deviating notification settings.

​
Example configuration app.instances.deutsch

{
  "base_url": "",
  "country": "",
  "country_code": "",
  "id": "",
  "label": "",
  "notificationSettings": {
    "defaultSettings": {
      "basketReminder": "undefined",
      "birthdayGreetings": "undefined",
      "deliveryNotification": "undefined",
      "news": "undefined",
      "teaser": "undefined"
    },
    "personalizedMessages": {
      "basketReminder": false,
      "birthdayGreetings": false,
      "deliveryNotification": false
    }
  },
  "shop_url": "",
  "v8": {
    "base_url": ""
  }
}

​
Parameter overview

ParameterTypeDescription
base_urlstringBase URL of the app instance.
countrystringName of the country to which the instance is assigned.
country_codestringCountry code of the instance (e.g. DE, AT).
idstringUnique identifier of the app instance (e.g. de_shop, eu_shop).
labelstringReadable name of the instance (e.g. “Germany shop”, “EU app”).
notificationSettingsobjectOptional notification settings that can override the global app defaults.
defaultSettingsobjectDefines the default settings for notifications in this instance.
basketReminderboolEnables/disables personalised basket reminders.
birthdayGreetingsboolEnables/disables personalised birthday greetings.
deliveryNotificationboolEnables/disables personalised delivery/shipping notifications.
newsenumDefault for newsletter notifications.
Values: undefined, enabled, disabled
teaserenumDefault for promotional messages.
personalizedMessagesobjectEnables/disables certain personalised messages for this instance.
basketReminderboolEnables/disables personalised basket reminders.
birthdayGreetingsboolEnables/disables personalised birthday greetings.
deliveryNotificationboolEnables/disables personalised delivery/shipping notifications.
shop_urlstringURL of the associated online shop used in the app.
v8objectOptional V8-specific configuration for this instance.
base_urlstringBase URL of the connected V8 shop instance for this app instance.