> 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/developer/player-control/local-player-api/webhooks.md).

# Webhooks

Using the interactive control library it is possible to [send a web hook](https://github.com/xibosignage/xibo-interactive-control#trigger-actionweb-hook) to the Player. Any incoming web hook will be tested against the currently running Actions which have been configured on the current Layout or Schedule. If a match is found, the web hook Action will be executed and the corresponding Action taken.

{% hint style="info" %}
The default configuration is to only allow web hooks incoming on `localhost`, effectively securing them only for use by Widgets. If an external system needs to call a web hook, one or more Displays can be configured to allow WAN connections to their web server in the Display Settings Profile.
{% endhint %}

### Trigger Code

All web hooks must supply a `trigger` parameter which will be matched against the “Trigger Code” of any configured Actions.

### Running commands

A particularly powerful usage of this mechanism is to have a Navigate to Widget Action which loads a Shell Command. This will execute the specified command without effecting other playback.

This functionality can be used to have an incoming web hook trigger another series of actions.


---

# 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/developer/player-control/local-player-api/webhooks.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.