Developer Changelog / App Bridge Sidekick

Sidekick Launch API
Start a Sidekick conversation from a button in your app

Embedded apps can now launch Sidekick with a pre-filled prompt. Merchants get help that fits their current context without leaving the app.

On this page
  1. What's changing (in 30 seconds)
  2. How it works: from button click to conversation
  3. How to call it (code example)
  4. Before vs. Sidekick Launch API
  5. What the article covers / doesn't cover
  6. Integration flow (3 steps)
  7. 5 key points for developers
  8. 3 practical use cases
  9. One-line summary for proposals

1What's changing

From an embedded app in the Shopify admin,apps can now start a Sidekick conversation on the merchant's behalf .
Sidekick opens with the app's prompt already sent as the merchant's own message .

Before: the app and Sidekick were separate

When questions came up in an app screen, merchants had to open Sidekick themselves and explain the situation from scratch.

Now: launch from the app with context

A single button in the app starts a Sidekick conversation with a prompt tailored to that screen. Merchants never leave the app.

2How it works: from button click to conversation

Merchant Clicks the button Embedded app e.g., next to a report "Ask Sidekick" button In the Shopify admin shopify.sidekick .launch({ message }) Sidekick Launch API Sidekick opens The app's prompt is sent as the merchant's message Get help without leaving the app
The key point is that it starts a conversation "on behalf of the merchant" . The message you pass is treated in Sidekick as a message sent by the merchant .

3How to call it (code example)

The article shows only this one-line call.

// Example: when an "Ask Sidekick" button placed next to a report is clicked
shopify.sidekick.launch({ message })
Caller

Embedded apps

Apps that run inside the Shopify admin (Embedded apps).

Arguments

message

The prompt to prefill. It is sent as the merchant's message. No other arguments are documented.

Result

Sidekick opens

The conversation starts with the prompt already sent. How to get a return value or the response isn't documented.

4Before vs. Sidekick Launch API

ItemBeforeSidekick Launch API
Who opens Sidekick Merchant Opens it themselves App Starts it on the merchant's behalf
First question Typed manually Explains the situation from scratch Prefilled The app prepares the prompt
Context Depends on the merchant's explanation Can ask with context that matches the app screen
Navigation — Within the app Get help without leaving the app
Additional cost / eligible plans — Not stated

5What the article covers / doesn't cover

What it says

Applies to embedded apps
Can be called from within the Shopify admin
shopify.sidekick.launch({ message }) launches it
The prompt is sent as a message from the merchant
See the Sidekick Launch API documentation for details

What it doesn't say (not mentioned)

Required scopes / permissions
Eligible plans, regions, and supported languages
message character limit
Whether the app can receive a return value or Sidekick's response
Pricing and rate limits

The changelog entry is brief and doesn't cover constraints or specification details. Before implementing, be sure to check the Sidekick Launch API documentation .

6Integration flow (3 steps)

1

Choose the placement

As in the example, place it next to screens where questions tend to come up, such as reports.

2
Ask

Add an "Ask Sidekick" button

On click, call shopify.sidekick.launch({ message }) .

3

Design the prompt

message is sent as the merchant's own message, so write it with that in mind.

In the article, the implementation is just a single function call. Simply add a button to an existing embedded app to create an entry point for in-app help.

75 key points for developers

1. Applies to embedded apps

It assumes calls from an embedded app running inside the Shopify admin. Use from apps outside the admin is not mentioned.

launch()

2. The API is accessed via the global shopify object

shopify.sidekick.launch({ message }) is how it's called. The only argument mentioned in the article is message .

3. Messages are sent on the merchant's behalf

The prompt is sent as a "message from the merchant." Write natural wording the merchant would plausibly use, and design it so it doesn't include unintended requests.

4. Think of it as a one-way launch API

The article only covers starting a conversation. Whether the app can receive Sidekick's response is not mentioned.

5. Detailed specs live in the documentation

Permissions, limits, and error behavior are not covered in the Changelog.It's safest to check the Sidekick Launch API documentation before you start designing .

83 use cases you can put to work

?
USE CASE 1

Put an "Ask Sidekick" button on report screens

Problem
Merchants looking at an app's report get stuck on how to interpret the numbers and have to re-ask their question on a separate screen.
Solution
Place an "Ask Sidekick" button next to the report and call shopify.sidekick.launch({ message }) with a prompt tailored to that report.
Impact
Merchants get context-aware help right where they are, without leaving the app.
Tech note
This is the exact example from the article. The prompt is sent as the merchant's own message, so write it from the merchant's point of view.
USE CASE 2

Add an "ask if you're stuck" entry point to your app's settings screen

Problem
In apps with many settings, merchants lack a clear path to get help when they're unsure.
Solution
Place buttons near each section of the settings screen that launch Sidekick with a prompt describing that screen's context.
Impact
Merchants can start asking questions without explaining their situation from scratch.
Tech note
The Changelog doesn't say how much of the app's settings Sidekick takes into account when answering. Validate answer quality beforehand.
USE CASE 3

Make "Sidekick integration" a standard option in client app proposals

Problem
Even after a custom app is delivered, "how do I use this?" questions from operators tend to land on the dev team.
Solution
Add Sidekick launch buttons on key screens as a standard item in your proposal menu.
Impact
A single function call gives the app an entry point to context-aware help.
Tech note
Eligible plans, permissions, and limits are not documented. Verify behavior in the docs and on the target store before proposing.

9One-line summary for proposals

"With a single button in an embedded app, you can starta Sidekick conversation with a prompt tailored to that screen .
shopify.sidekick.launch({ message }) is all it takes for merchants to get help without leaving the app."