Sharing
This is a legacy API. Use the latest version of Share
instead.
The Share
action allows you to invoke the "share sheet" to share content from your embedded app on an iOS or Android device.

Anchor to RequirementsRequirements
These actions require the following app versions:
- Shopify iOS v8.22.0 or above
- Shopify Android v8.25.0 or above
- Point of Sale iOS v5.29.0 or above
- Point of Sale Android v3.24.0 or above
Anchor to SetupSetup
Create an app and import the Share
module from @shopify/app-bridge/actions
. Note that we'll be referring to this sample application throughout the examples below.
In the following example, config
is a valid App Bridge configuration object. Learn more about configuring App Bridge.
Group | Share |
---|---|
Action | CLOSE |
Action Type | APP::SHARE::CLOSE |
Description | Dispatches after closing the Share Sheet. |
The Share
action lets you share content from your app to any third-party app on the user's device, as long as the app supports the payload type. Some apps only support text and some support URLs and text.
Anchor to ResponseResponse
Key | Type | Description |
---|---|---|
success | Boolean | Whether the share was successful or canceled. |
Group | Share |
---|---|
Action | SHOW |
Action Type | APP::SHARE::SHOW |
Description | Opens a Share Sheet that allows you to share content with other apps. |
Note: In Debug Mode, text
and url
are optional but at least one needs to be included in the payload. If neither are present then an APP::ERROR::INVALID_PAYLOAD
will be thrown or sent to an Error subscriber. However, in Production Mode this will silently fail.
Anchor to RequestRequest
Key | Type | Description |
---|---|---|
text | String? | The text to share. |
url | String? | The URL to share. |