---
title: Support API
description: >-
  The Support API lets you register a custom handler when merchants request
  support through App Bridge. This handler is triggered when a merchant clicks
  the support button at the top of the app, allowing you to provide in-app
  support such as opening a live chat widget.
api_version: v1.0
source_url:
  html: >-
    https://shopify.dev/docs/api/app-home/latest/apis/user-interface-and-interactions/support-api
  md: >-
    https://shopify.dev/docs/api/app-home/latest/apis/user-interface-and-interactions/support-api.md
api_name: app-home
---

# Support API

**Info:**

App Bridge isn't versioned with Polaris. App Bridge APIs and web components are identical in every App Home reference version.

The Support API lets you register a custom handler when merchants request support through App Bridge. This handler is triggered when a merchant clicks the support button at the top of the app, allowing you to provide in-app support such as opening a live chat widget.

**Tip:**

To register a custom support callback, you must define a [Support link extension](https://shopify.dev/docs/apps/launch/distribution/support-your-customers#custom-support-events) that points to a page within your app. Without this extension, the support callback is ignored.

### Use cases

* **Custom support flows:** Register a handler to customize what happens when merchants click the support button.
* **In-app help:** Redirect support requests to your app's custom help system or knowledge base.
* **Support routing:** Route support requests based on context, like the current page or merchant plan.
* **Integrated assistance:** Provide integrated support experiences without leaving the app.

### Methods

The `support` object provides a method that registers a callback function to run when support is requested.

* **register​Handler**

  **(callback: SupportCallback) => Promise\<void>**

  Registers a callback function to run when the merchant clicks the support button. Pass `null` to unregister a previously registered handler.

### SupportCallback

A callback function that runs when support is requested.



returns

```ts
void | Promise<void>
```

Examples

### Examples

* ####

  ##### Description

  Register a support handler. This example registers a callback function that runs when the merchant clicks the support button. Use this to open a live chat widget, display a contact form, or trigger any custom support flow.

  ##### js

  ```js
  // Define the callback function
  const handler = () => {
    // implement your custom functionality
    openLiveChat();
  };

  // Register the callback
  shopify.support.registerHandler(handler);
  ```

***