> For the complete documentation index, see [llms.txt](https://docs.ndi.video/all/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/webhooks.md).

# Webhooks

NDI Bridge Service supports change subscriptions which allow you to observe changes to any value instead of polling. To register a webhook, append the following path to the target API value where the `callback` query parameter is set to the URL you wish to receive POST requests from:

`/subscribe?callback=https://myurl`

For instance, if you wanted to subscribe to changes on the host port value you would do:

`api/host/port/subscribe?callback=https://myurl`

If a subscription is successful, you will revive a GUID as a response. This GUID is the handle for your subscription. If you want to unsubscribe from any change subscription you call the following URL (do not appended to the target API path) with the `id` query parameter being set to the GUID you received from the subscribe response:

`http://localhost:8080/api/unsubscribe?id=`

Change subscriptions are POSTed to the callback URL as JSON with *key* being the target API path (like `host/port` ) and *value* being the current value or ”Value changed.” for security sensitive values.

Active webhooks can be seen under the **Webhooks** section of the web interface.

![Command Line Interface](/files/fF8j9GaJLSxet5bNLVD6)


---

# 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.ndi.video/all/developing-with-ndi/utilities/bridge-service/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.
