> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

## Usage

### Open an external URL

```typescript
import { requestOpenExternalUrl } from '@canva/platform';

await requestOpenExternalUrl({
  url: 'https://www.example.com',
});
```

### Detect when a user navigates to the external URL

```typescript
import { requestOpenExternalUrl } from '@canva/platform';

const response = await requestOpenExternalUrl({
  url: 'https://www.example.com',
});

if (response.status === 'completed') {
  // URL opened successfully
}
```

### Detect when a user doesn't navigate to the external URL

```typescript
import { requestOpenExternalUrl } from '@canva/platform';

const response = await requestOpenExternalUrl({
  url: 'https://www.example.com',
});

if (response.status === 'aborted') {
  // User declined to open URL
}
```

## Parameters

<Prop.List>
  <Prop name="request" required type="OpenExternalUrlRequest" sourceLineNumbers={[663]}>
    Options for prompting the user to open an external URL.

    <PillAccordion defaultExpanded={true} title={<>Properties of <strong>request</strong></>}>
      <Prop.List>
        <Prop name="url" required type="string" sourceLineNumbers={[565]}>
          The URL to open.
        </Prop>
      </Prop.List>
    </PillAccordion>
  </Prop>
</Prop.List>

## Returns

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

<Tabs>
  <Tab name="Completed">
    The result when a user agrees to navigate to an external URL.

    <Prop.List>
      <Prop name="status" required type="string" sourceLineNumbers={[554]}>
        The status of the request.

        The only valid value is `"completed"`.
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="Aborted">
    The result when a user doesn't agree to navigate to an external URL.

    <Prop.List>
      <Prop name="status" required type="string" sourceLineNumbers={[543]}>
        The status of the request.

        The only valid value is `"aborted"`.
      </Prop>
    </Prop.List>
  </Tab>
</Tabs>