> For the complete documentation index, see [llms.txt](https://docs.akenza.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.akenza.io/device-management/your-data-flow/connectors/streaming/webhook.md).

# Webhook

This page describes webhook action in more detail

The webhook action can be used to invoke any third-party **REST API** and sends the sample in the request body.

The HTTP method, multiple custom headers, content type, and authentication method can easily be specified.<br>

Authentication flows (e.g. Oauth2) are not yet supported.

{% hint style="info" %}
The whole sample will be forwarded to the invoked endpoint. Make sure you trust the API in question and don't include sensitive data in the sample.
{% endhint %}

![Webhook template](https://2165942204-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MMKXTFIN5ZlLOjBlfC4%2Fuploads%2Fo1gegxan4BnuwNHVXsap%2Fscreely-1685093202840.png?alt=media\&token=1f2e04eb-2227-4a76-8356-2dc71358e8d5)

### Templating

It is possibly the dynamically customize the webhook url by using template variables. For example `https://webhook-url.com?deviceId={{deviceId}}`. Available variables are listed [here](/reference/message-templating.md).

Notably, each template will be url encoded.

```
template: https://example.com/{{data.param1}}/{{data.param2}}
data.param1: workspaces
data.param2: devices
result: https://example.com/workspaces/devices
```

Avoid to template the full path as `/` will also be encoded:

```
template: https://example.com/{{data.param1}}
data.param1: workspaces/devices
result: https://example.com/workspaces%2Fdevices
```


---

# 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.akenza.io/device-management/your-data-flow/connectors/streaming/webhook.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.
