# Webhook

Um serviço oferecido pela **Pier Cloud** que permite integrar a nossa **plataforma de FinOps** com o **serviço de Webhook** para envio de notificação via endpoint, sempre que for desejado que o envio de mensagem através do endpoint cadastrado para o serviço utilizado pelo endpoint.

Este documento descreve as etapas necessárias para configurar e gerenciar essa integração, garantindo que suas equipes recebam notificações de forma eficiente e tenham acesso às informações de que precisam.

### Conectando o serviço de Webhook a Plataforma da Pier Cloud 

1. Clicando no perfil do usuário, na opção “**Configurações**”, conforme ilustrado abaixo:

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2Fyf0ggqkChkNxgXBchCDT%2Fimage.png?alt=media&#x26;token=42cb1a4c-14ab-4c6e-88d2-ea9202e18fe1" alt=""><figcaption></figcaption></figure>

2. O sistema apresentará o menu lateral com algumas opções de configuração, onde deve ser selecionada a opção “**Notificações**”:

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2FFaLsrI6kCXa6rRd9vVke%2FCaptura%20de%20Tela%202025-08-15%20a%CC%80s%2016.32.32.png?alt=media&#x26;token=a3054c67-caea-4ff2-8c49-7dc7f38fa49c" alt=""><figcaption></figcaption></figure>

3. Clicando no ícone "![](https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2FVBfv8tfpzEXXbSvlWQyn%2Fimage.png?alt=media\&token=55aec71c-d6ab-47d3-b884-7e8fa81d3664)", o sistema permite visualizar os grupos de provedores cadastrados e adicionar novos.&#x20;

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2FEg6K516Sw0dq1rZoGlk0%2Fimage.png?alt=media&#x26;token=46ef6903-50bd-4664-97d4-e27cea1fe8d2" alt=""><figcaption></figcaption></figure>

4. O sistema irá apresentar a tela solicitando as seguintes informações:

* **Selecione o tipo**: Webhook
* **Nome**: Informar um nome que identifique o provedor

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2FxNjYT2RXfrrqyaSfo70v%2Fimage.png?alt=media&#x26;token=ee43065e-5bfd-4581-a783-06e238284c2e" alt="" width="563"><figcaption></figcaption></figure>

***

### Configuração via requisição Get ou Post

* **Configurações**: Para o tipo de provedor **Webhook**, será necessário preencher os seguintes campos adicionais:

  * **URL do servidor**: Se refere ao endpoint do serviço que irá receber as notificações.
  * **Método de requisição**: selecionar entre as opções disponíveis:

    * **GET**: Ao selecionar a opção de método GET, as informações da notificação que contêm título e conteúdo, serão enviadas como *Query parameters* da URL. Nesse caso, as informações devem ser retiradas da URL e utilizadas como desejado.

    **Exemplo**:&#x20;

  curl --request GET\
  \--url '<https://exemplo.com/webhook?**title=Novo%20alerta%20de%20sistema\\&content=O%20processamento%20foi%20concluido%20com%20sucesso%20as%2014%3A35>'\*\*

  * No exemplo, [https://destino.com/webhook?title=SEU\_TITULO\&content=SEU\_CONTEUDO<br>](https://destino.com/webhook?title=SEU_TITULO\&content=SEU_CONTEUDO)O servidor que recebe o webhook precisa estar preparado para ler parâmetros GET (`req.query.title` / `req.query.content` em Node.js, **por exemplo)**.

    * **POST**: Ao selecionar a opção de método POST, as informações da notificação que contêm título e conteúdo, serão enviadas dentro do body de uma requisição http básica. Nesse caso, as informações devem ser retiradas da Body e utilizadas como desejado.

    **Exemplo**:&#x20;

    curl --request POST\
    \--url '<https://exemplo.com/webhook'\\>
    \--header 'Content-Type: application/json'\
    \--data '{\
    "title": "Novo alerta de sistema",\
    "content": "O processamento foi concluído com sucesso às 14:35."\
    }'
* **Cabeçalho da requisição**: Inserir as informações que serão enviadas:
  * Informe a chave: Fornecer a chave que será utilizada.
  * Informe o valor: Inserir o valor para a chave e clique em **adicionar**.

Por fim, ao clicar no botão **salvar**, o sistema irá armazenar a configuração realizada.