> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/kb/features/webpage-widget.md).

# Webpage Widget

Include content from a webpage.

## Open Natively <a href="#content-open-natively" id="content-open-natively"></a>

When selected, the Player will open the webpage without any alterations and will open and render in the browser as if the URL had been visited on the device outside Xibo.

{% hint style="warning" %}
There is no preview available with this option!
{% endhint %}

## Trigger a web hook <a href="#content-trigger-a-web-hook" id="content-trigger-a-web-hook"></a>

Trigger a web hook for an active action (navigate to Widget, navigate to Layout a Scheduled Command etc.) to be shown in the event the webpage returns an error and fails to load.

* Enter the **Trigger Code** of a configured Action to match against a supplied web hook `trigger` parameter.

## Manual Position <a href="#content-manual-position" id="content-manual-position"></a>

This option will embed the webpage in an iframe where users can specify the dimensions required.

* Use the Offset and Scale settings to force the page/sections of the page to fit within the dimensions to show just a section of the webpage.

## Best Fit <a href="#content-best-fit" id="content-best-fit"></a>

This option will embed the webpage in an iframe where users can specify the dimensions required.

**NOTE:** **Manual Position** and **Best Fit** options will not work with websites that set the **X-Frame-Options header**. If you are unable to see the webpage use the Open Natively option when using Windows / Linux or Android.

{% hint style="danger" %}
If X-Frame-Options are set then webOS and Tizen will not work in any mode!
{% endhint %}

If X-Frame-Options are not set then the website should show in any of the Players, using any of the above options.

Use this [X-Frame-Options Header Checker Tool](https://geekflare.com/tools/x-frame-options-test) to see if the header has been set for the webpage you wish to target.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xibosignage.com/kb/features/webpage-widget.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
