When you generate an external URL extension, the CLI adds a <your-extension-name>.extension.ts to your project that contains the external URL builder configuration.
The <your-extension-name>.extension.ts file contains an external URL builder configuration.
Here's an example builder definition:
The following fields can be used in the configuration object:
| Field | Type | Description |
|---|---|---|
id | string | Extension ID as a GUID. It must be unique across all extensions in the app. |
url | string | Your external service's address. When a site collaborator opens your app from the Manage Apps page in their site dashboard, their browser opens this address in a new tab. For security reasons, you must host your app on an https address. |
Last updated: 16 July 2026