> For the complete documentation index, see [llms.txt](https://docs.skyone.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.skyone.cloud/english/skyone-studio/integrations/flows/triggers-of-a-flow/webhook-triggers-adding-and-setting.md).

# Webhook Triggers: Adding and Setting

Here's how to add and configure a Webhook Trigger:

* [Adding a Simple Webhook Trigger (HTTP)](#adding-a-simple-webhook-trigger-http)
  * [Settings](#settings)
  * [Request specifications](#request-specifications)
    * [Execution limit](#request-specifications)
  *  [BODY](#body)
* [Adding a Webhook Trigger with OpenAPI Schemas (HTTP)](#adding-a-webhook-trigger-with-openapi-schemas-http)

### Adding a Simple Webhook Trigger (HTTP) <a href="#adding-a-simple-webhook-trigger-http" id="adding-a-simple-webhook-trigger-http"></a>

To add a Webhook trigger, follow these steps:

1. Click on "**Start with a trigger".**
2. Click on the plus sign of the "**Webhook"** option. You will then open the modal to configure it and view more information.
3. This modal is divided into two areas: **Info banner,** **Settings** and **Request specifications**.

<figure><img src="/files/MCAltuVItlh18n8qj35q" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
[Find out about the Module Header here](/english/skyone-studio/integrations/flows/module-header.md).
{% endhint %}

#### Settings <a href="#settings" id="settings"></a>

By default, the Webhook address is preset in Skyone Studio and can be copied using the specific icon located on the right side of the screen.

<figure><img src="/files/6X6aphSNyIfmaLKRDJ45" alt=""><figcaption></figcaption></figure>

Additionally, there is the option to "**Require Authentication.**" Without using OpenAPI, you will only have the option to enable authentication requests with a predefined Username and a mandatory Password, which will not be required when running the flow inside Skyone Studio:

#### Request specifications <a href="#request-specifications" id="request-specifications"></a>

Flows can be triggered using the following **MEDIA TYPE** formats:

1. application/json
2. application/x-www-form-urlencoded)

Select one of the two, according to your needs, using the arrow in the right-hand corner.

**Execution limit**

You can manage the number of executions of your Webhook Trigger through the "**Execution Limit",** i.e. determining the maximum number of times the WebHook will be requested over a period of time.

To do this, choose the number and time measure (second, minute or hour) you want.

#### BODY <a href="#body" id="body"></a>

Under "**Use Body in request"**, use the **enable** button to show the feature. By default, the Body tab is displayed:

<figure><img src="/files/7eqZVXRdPX6tOUPx1fmf" alt=""><figcaption></figcaption></figure>

This field allows you to use a body in JSON format, which you may or may not want to convert to YAML. When used, it appears as a parameter with the same name (**body**) in the other components of the flow, and you can filter your data using a SMOP or the [Data Transformation](/english/skyone-studio/integrations/flows/tool-modules/data-transform-module.md) tool module.

If you want to use the JSON format so that Skyone Studio converts the code to YAML, use this tab in the Webhook trigger configuration and click **"Generate Schema."**

Skyone Studio will verify if your JSON is valid and, if everything is correct, it will automatically generate your schema in YAML.

Alternatively, you can choose to use only the BODY without generating a YAML schema by clicking **"Save"** to keep the changes. This will cause Skyone Data not to validate the type of parameter used.

{% hint style="warning" %}
If there is an error, check the error message, make the necessary corrections and try again.
{% endhint %}

### **Adding a Webhook Trigger with OpenAPI Schemas (HTTP)** <a href="#adding-a-webhook-trigger-with-openapi-schemas-http" id="adding-a-webhook-trigger-with-openapi-schemas-http"></a>

As well as adding a simple Webhook trigger, we can add an OpenAPI - optional settings, but which allow us to pass parameters directly to the trigger, right at the start of the POST request.

To get started, under "**Use Body in request"**, use the **enable** button to activate the feature. Next, choose the "**Open API Schemas"** tab.

<figure><img src="/files/KZv1XQNuQ8g6YV0PPRYm" alt=""><figcaption></figcaption></figure>

Here, you will have the option of specifying your schema by adding parameters if you want to write your schema directly in YAML. Any parameters you add must be contained in the `webhook_request`variable. In the example above, we have a simple schema, with the csv parameter, which must be of string type. This parameter must be entered at the time of the POSTMAN (or similar) request. For better visualization, here is the same code in text:

```json
components:
  schemas:
    webhook_request:
      type: object
      properties:
        csv:
          type: string
```

To finalize the trigger settings, click on "**Save**".

Read also:

* [Edit trigger](/english/skyone-studio/integrations/flows/editing-triggers-and-modules.md)

***


---

# 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.skyone.cloud/english/skyone-studio/integrations/flows/triggers-of-a-flow/webhook-triggers-adding-and-setting.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.