# 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="https://2406186417-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGHvosl2xodpQaXzCzxY%2Fuploads%2FQ8TMF9ROUCeJXvsI0rLM%2Fadd-gatilho-webhook2.gif?alt=media&#x26;token=d1158d9e-b0eb-47c6-bcc6-9141e91086de" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
[Saiba sobre o Cabeçalho do Módulo aqui](https://docs.skyone.cloud/skyone-studio/integracoes/cabecalho-dos-modulos).&#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="https://2406186417-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGHvosl2xodpQaXzCzxY%2Fuploads%2FKnnTlUhnxfTWuROhUfLE%2F01B29D63-64F8-499A-80EF-065B94CBCB67.png?alt=media&#x26;token=22e40ba0-8f4f-489d-951a-d71267683e68" 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="https://2406186417-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGHvosl2xodpQaXzCzxY%2Fuploads%2FK5EJlXshfzg7akahxPqG%2F0484FFDC-D850-4000-9526-E441CEB94D1C.png?alt=media&#x26;token=f2b38159-9f53-49e4-9b9e-cbb9159abff7" 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](https://docs.skyone.cloud/skyone-studio/integracoes/operacoes-de-dados/smop-pequenas-operacoes) ou do módulo ferramental [Data Transformation.](https://docs.skyone.cloud/skyone-studio/integracoes/fluxos/modulos-ferramentais/modulo-transformacao-de-dados)

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="https://2406186417-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGHvosl2xodpQaXzCzxY%2Fuploads%2FsQFwCv0hTzoyWdDssQss%2F18DEDDEA-223E-4D9F-B2E6-7B72F6A7736E.png?alt=media&#x26;token=8a863c14-acd8-4b8d-8cd2-7dfc7bf75760" 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](https://docs.skyone.cloud/skyone-studio/integracoes/edicao-de-gatilhos-e-modulos-no-fluxo)
