> For the complete documentation index, see [llms.txt](https://help.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/advocate-program/advocate-program-settings/create-and-manage-advocate-webhook-subscriptions.md).

# Criar e gerenciar assinaturas de webhook do Advocate

Webhooks são código que é executado quando um evento acontece. O Advocate permite que você use webhooks para registrar uma URL para a qual faremos um POST sempre que um evento acontecer no seu programa; por exemplo, quando um código de cupom exclusivo é criado para um novo participante, um objeto de evento é criado. Há dois métodos para criar e gerenciar webhooks: [pela API do Advocate](https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-api/api-webhooks-for-advocate-programs) ou na plataforma Advocate. Este artigo de ajuda explicará como gerenciar webhooks pela plataforma Advocate.

#### Criar uma assinatura de webhook

1. Na barra de navegação superior, selecione ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2F210dEQa93qyQgoJDkieL%2FUser%20profile.svg?alt=media\&token=f84c5b17-fae4-4a30-990a-9de5e57a150b) **\[Perfil do usuário] → Configurações**.
2. Na coluna da esquerda abaixo *Configurações do Advocate*, selecione **Webhooks**.
3. Na *Assinaturas de webhook* na página, selecione **Criar assinatura**.
4. Abaixo *Postar na URL*, digite o endereço exclusivo que o aplicativo usa para enviar atualizações em tempo real sobre eventos específicos.
5. Opcionalmente, abaixo *Nome do webhook*, digite o nome da nova assinatura de webhook.
6. Selecione **Salvar**.

#### Solucionar problemas nos logs de webhook

Quando você registra uma URL para a qual o Advocate faz post sempre que um evento acontece no seu programa, você pode revisar os logs e solucionar problemas de quaisquer eventos de webhook que falharem.

**Acesse seus logs de webhook**

1. Na barra de navegação superior, selecione ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2F210dEQa93qyQgoJDkieL%2FUser%20profile.svg?alt=media\&token=f84c5b17-fae4-4a30-990a-9de5e57a150b) **\[Perfil do usuário] → Configurações**.
2. Na coluna da esquerda abaixo *Configurações do Advocate*, selecione **Webhooks**.
3. Na *Assinaturas de webhook* na página, selecione **Ver logs**.
4. Use os filtros abaixo *Registro de eventos do webhook* para filtrar os webhooks.
   * Consulte a *referência dos filtros* abaixo para mais informações.

<details>

<summary>referência dos filtros</summary>

| Filtro  | Descrição                                                                                                                                                                                                      |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tipo    | Filtrar pelo webhook [tipo de evento](https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-api/api-webhooks-for-advocate-programs). Este filtro vem definido como *Todos os tipos*. |
| Período | Filtrar pelo período em que o webhook foi atualizado pela última vez. Este filtro vem definido como *Todo o período*.                                                                                          |

</details>

**Ver detalhes do webhook**

1. Selecione um webhook específico para abrir a *Detalhes do webhook* visualização.
2. Esta visualização fornece informações que podem ser usadas para solucionar problemas em uma assinatura de webhook.
   * Consulte a *Referência do evento* abaixo para mais informações.

<details>

<summary>Referência do evento</summary>

| Filtro                 | Descrição                                                                                                                                                                                                                                                                                                                                                      |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tipo                   | O webhook [tipo de evento](https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-api/api-webhooks-for-advocate-programs).                                                                                                                                                                                                            |
| ID do webhook          | O identificador exclusivo do webhook.                                                                                                                                                                                                                                                                                                                          |
| Data de criação        | A data em que o webhook foi criado.                                                                                                                                                                                                                                                                                                                            |
| Dados do evento        | O webhook [carga útil](https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-api/api-webhooks-for-advocate-programs).                                                                                                                                                                                                                |
| Assinatura(s)          | As assinaturas de webhook para as quais o webhook foi enviado e seus respectivos status.                                                                                                                                                                                                                                                                       |
| Detalhes da assinatura | Detalhes sobre a resposta recebida do endpoint da assinatura de webhook. Os detalhes podem incluir a tentativa de entrega do webhook, mostrando o carimbo de data/hora da tentativa, o código de status HTTP recebido do destino e se a tentativa expirou devido ao tempo excessivo necessário para a solicitação receber uma resposta do servidor de destino. |

</details>

**Sistema de nova tentativa de webhook para entregas de eventos com falha**

* Os webhooks são entregues imediatamente após um evento ser acionado. Se o endpoint não responder com sucesso a uma tentativa de entrega (ou seja, responder com um código de status diferente de 200), a entrega será considerada como falha.
* As entregas com falha serão tentadas novamente a cada hora após a tentativa com falha anterior, até que uma entrega bem-sucedida seja feita ou até que 72 tentativas tenham sido feitas (aproximadamente 3 dias, à taxa de 1 nova tentativa por hora).
* Endpoints de webhook que retornam erros de forma consistente serão desativados automaticamente após o seguinte número de erros:

  | Código de status | Erros recebidos |
  | ---------------- | --------------- |
  | Erros 4xx        | 1000            |
  | Erros 5xx        | 2000            |
  | Erros 3xx        | 2000            |


---

# 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://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/advocate-program/advocate-program-settings/create-and-manage-advocate-webhook-subscriptions.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.
