> 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/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 Shell Command widget in your drawer, and use a Navigate to Widget Action, targeted to the Screen. 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.

Links:

* <https://account.xibosignage.com/docs/developer/player-control/webhooks#content-webhooks>
* <https://account.xibosignage.com/docs/developer/player-control/webhooks#content-trigger-code>
* <https://account.xibosignage.com/docs/developer/player-control/webhooks#content-running-commands>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xibosignage.com/developer/player-control/webhooks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.