# Gatilhos Webhook: Adição e Configuração

A seguir, saiba adicionar e configurar um Gatilho Webhook:

* [Adição de um Gatilho Webhook Simples (HTTP)](#adicao-de-um-gatilho-webhook-simples-http)
  * [Configurações](#configuracoes)
  * [Especificações da requisição](#especificacoes-da-requisicao)
    * [Limite de execuções](#especificacoes-da-requisicao)
  * [BODY](#body)
* [Adição de um Gatilho Webhook com OpenAPI Schemas (HTTP)](#adicao-de-um-gatilho-webhook-com-openapi-schemas-http)

### Adição de um Gatilho Webhook Simples (HTTP) <a href="#adicao-de-um-gatilho-webhook-simples-http" id="adicao-de-um-gatilho-webhook-simples-http"></a>

Para adicionar um gatilho Webhook, siga os seguintes passos:

1. Clique em "**Comece com um gatilho"**.
2. Clique no sinal de mais da opção **Webhook.** Em seguida, abrirá o modal para configurá-lo e visualizar mais informações.&#x20;
3. Este modal é dividido nas seguintes áreas: **Cabeçalho**, **Configurações** e **Especificações da Requisição**.

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

{% hint style="info" %}
[Saiba sobre o Cabeçalho do Módulo aqui](/skyone-studio/integracoes/cabecalho-dos-modulos.md).&#x20;
{% endhint %}

#### Configurações <a href="#configuracoes" id="configuracoes"></a>

Por padrão, o **endereço** do Webhook é predefinido no **Skyone Studio**, sendo possível copiá-lo no ícone específico - localizado no lado direito da tela.

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

Além disso, há a opção de "**Solicitar autenticação"**. Sem utilizar OpenAPI, você terá somente a opção de ativar a solicitar autenticação com **Usuário** (predefinido) e **Senha** (obrigatória), que não serão exigidos ao rodar o fluxo dentro do **Skyone Studio:**

**Especificações da requisição**

Os fluxos do **Skyone Data** podem ser acionados utilizando os seguintes formatos de **MEDIA TYPE** (tipo de mídia):

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

Selecione um dos dois, conforme a sua necessidade, utilizando a seta no canto direito.&#x20;

**Limite de execuções**

É possível gerenciar a quantidade de execuções do seu Gatilho Webhook através do "**Limite de Execuções"**, ou seja, determinar o máximo de vezes em que o WebHook será requisitado durante um período de tempo.

Para isso, escolha o número e a medida de tempo (segundo, minuto ou hora) desejados.

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

Em "**Utilizar Body na requisição"**, use o botão de **ativar** para mostrar o recurso. Por padrão, a aba Body é apresentada:

<figure><img src="/files/8rFvYObGWh8OCn7HVP37" alt=""><figcaption></figcaption></figure>

Este campo permite que você utilize um body no formato JSON, que você pode ou não querer converter para YAML. Quando usado, aparece como um parâmetro com o mesmo nome (**body**) nos demais componentes do fluxo, sendo possível filtrar seus dados por meio de uma [SMOP](/skyone-studio/integracoes/operacoes-de-dados/smop-pequenas-operacoes.md) ou do módulo ferramental [Data Transformation.](/skyone-studio/integracoes/fluxos/modulos-ferramentais/modulo-transformacao-de-dados.md)

Caso queira utilizar o formato JSON para que o **Skyone Studio** converta o código em YAML, utilize esta aba da configuração do gatilho Webhook e clique em "**Gerar Schema"**.

O **Skyone Studio** verificará se o seu JSON é válido e, se estiver tudo certo, gerará o seu schema em YAML automaticamente.

Opcionalmente, você pode utilizar apenas o BODY, sem gerar um schema em YAML, clicando em "**Salvar"** para guardar as alterações. Isso fará com que o Skyone Data não faça a validação do tipo de parâmetro utilizado.

{% hint style="warning" %}
Caso exista algum erro, verifique a mensagem de erro, faça as correções necessárias e tente novamente.
{% endhint %}

### **Adição de um Gatilho Webhook com OpenAPI Schemas (HTTP)** <a href="#adicao-de-um-gatilho-webhook-com-openapi-schemas-http" id="adicao-de-um-gatilho-webhook-com-openapi-schemas-http"></a>

Além de adicionar um gatilho Webhook simples, podemos adicionar utilizando um OpenAPI - configurações opcionais, mas que permitem que passemos parâmetros diretamente no gatilho, já no começo da requisição POST.

Para começar, em "**Utilizar Body na requisição"**, use o botão de **ativar** para acionar o recurso. Em seguida, escolha a aba "**Open API Schemas"**.

<figure><img src="/files/0HQUmejKbaIBf5Bh9LkG" alt=""><figcaption></figcaption></figure>

Aqui, você terá a opção de especificar o seu schema, adicionando parâmetros, caso queira escrever o seu schema diretamente em YAML. Quaisquer parâmetros adicionados devem estar contidos na variável `webhook_request`. No exemplo acima, temos um schema simples, com o parâmetro `csv`, que deve ser do tipo string. Este parâmetro deve ser informado no momento da requisição pelo POSTMAN (ou similar). Para melhor visualização, segue o mesmo código em texto:

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

Para finalizar as configurações do gatilho, clique em "**Salvar**".&#x20;

Leia também: [Editar gatilhos](/skyone-studio/integracoes/edicao-de-gatilhos-e-modulos-no-fluxo.md)


---

# Agent Instructions: 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:

```
GET https://docs.skyone.cloud/skyone-studio/integracoes/fluxos/gatilhos/gatilhos-webhook-adicao-e-configuracao.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.