App details

App name

The name of the app as displayed in the app store.

App description

A detailed description of the app and its functionality that is displayed on your apps page in the app store.

Short description

A brief description of the app shown in the listings in the app store.

Tags

Tags can be assigned to the app to categorize and improve display in the app store.

Visibility

Defines who can access the app. You can choose between the following:

  • Private apps are only available to tenants you manage in your organization.

  • Public apps are available to all tenants and require approval from Struct before being published.

Messaging version

Determines how the app communicates with Struct PIM. If your app depends on specific features, ensure the correct version is selected. If unsure, use the latest available version.

Install URL

The endpoint called when the app is installed. This allows you to prepare your app for the new installation and handle the installation process.

Uninstall URL

The endpoint called when the app is uninstalled, notifying the app

Icon URL

The URL of the icon displayed for the app in the app store.

Medias

Media content displayed on the app’s install page in the app store. These are used to visually present the app and give users an overview of its functionality before installation.

For best results, use images in a 16:9 format (for example 1920 × 1080).

Each media item includes the following:

  • Media type Defines the type of media being added

  • Media URL The URL of the media file to display

  • Thumbnail URL An optional thumbnail image used as a preview

  • Alternative text Descriptive text for accessibility and fallback display

  • Preview Displays how the media will appear in the app store

Requires subscription key

If enabled, users must provide a subscription key to install the app. Subscription keys can be used to manage and track individual installations.

App requires PIM API key

If enabled, a PIM API key is generated during installation. This key is used by the app to authenticate and communicate with Struct PIM.

Last updated