On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.

requestOpenExternalUrl

API reference for the requestOpenExternalUrl method.

Opens an external URL.

The URL is opened natively, such as in a new browser tab on desktop or in a browser sheet on mobile.

In some browsers, the user must enable popup permissions before any URL can be opened.

Parameters

requestOpenExternalUrlRequest
REQUIRED

Options for prompting the user to open an external URL.

Properties of request
urlstring
REQUIRED

The URL to open.

Returns

The result of prompting the user to open an external URL. This is a Promise that resolves with the following object:

The result when a user agrees to navigate to an external URL.

statusstring

The status of the request.

This must be "completed".

The result when a user doesn't agree to navigate to an external URL.

statusstring

The status of the request.

This must be "aborted".