> 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/account-administration/account-settings/notifications/enable-event-notification-postbacks-for-brands.md).

# Ative postbacks de notificações de eventos para marcas

Os postbacks de notificação de eventos (webhooks) notificam seus sistemas internos em tempo real quando eventos específicos ocorrem. Embora os dados enviados variem de acordo com o evento, o processo de configuração é o mesmo para todos.

{% stepper %}
{% step %}

## Acessar postbacks de notificação de eventos

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 seção *Técnico* selecione [**Notificações de eventos**](https://app.impact.com/secure/advertiser/accountSettings/techintegration/view-edit-adv-pingback-settings-flow.ihtml?).
   {% endstep %}

{% step %}

## Preencher os campos de configuração global

1. Passe o cursor sobre o evento para o qual deseja configurar um postback de notificação e selecione ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fkka3dqJOx8ZhiX82RDLt%2FEdit_light.svg?alt=media\&token=f454405c-ebd8-49af-90db-22efc27476bf) **\[Editar]**.
2. Use a tabela abaixo para configurar as opções de entrega:

<table><thead><tr><th width="225.36328125">Campo</th><th>Descrição</th></tr></thead><tbody><tr><td>URL</td><td>O endpoint no seu servidor que receberá os dados.</td></tr><tr><td>Método HTTP</td><td><p><code>GET</code>: os dados são anexados à URL como parâmetros de consulta.</p><p><code>POST</code>: os dados são enviados no corpo da solicitação, que inclui vários parâmetros opcionais que você pode definir.<br><br>Consulte <a href="#notification-events-and-payloads">Eventos de notificação e payloads</a> para saber mais sobre cada evento e o conteúdo do payload.</p></td></tr><tr><td>Cabeçalho HTTP</td><td>(Opcional) Adicione cabeçalhos personalizados para autenticação (por exemplo, <code>Authorization: Bearer token</code>).</td></tr><tr><td>Atraso mínimo</td><td>Defina <em>Atraso mínimo</em> em segundos para proteger seu servidor contra picos de tráfego.</td></tr><tr><td>Número máximo de solicitações</td><td>Defina <em>Número máximo de solicitações</em> por segundo para proteger seu servidor contra picos de tráfego.</td></tr><tr><td>Resposta de sucesso</td><td>A string de texto específica ou o código de status HTTP que seu servidor retorna quando um postback é processado corretamente.</td></tr><tr><td>Resposta de erro</td><td>A string de texto ou o código de status que indica uma falha (por exemplo, <code>ERROR</code> ou <code>500</code>).</td></tr></tbody></table>
{% endstep %}
{% endstepper %}

## Eventos de notificação e payloads

Cada notificação de evento envia um conjunto exclusivo de pontos de dados configuráveis (por exemplo, `{ActionId}`). Consulte os eventos abaixo para saber quais pontos de dados você pode extrair dos payloads.

<details>

<summary>Eventos do ciclo de vida da ação</summary>

Os eventos do ciclo de vida da ação enviam uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros incluídos) quando uma ação é rastreada, modificada ou revertida.

```json
// Um exemplo de POST no formato JSON
{
  "CampaignId": 9876, // ID do programa
  "ActionTrackerId": 12345, // ID do tipo de evento
  "MediaPartnerId": 555, // ID do parceiro
  "CampaignName": "Spring Global Promotion", // Nome do programa
  "ActionTrackerName": "Standard Sale Tracker", // Nome do tipo de evento
  "MediaPartnerName": "Top Tier Affiliates", // Nome do parceiro
  "ActionId": "ACT-778899", // ID da ação
  "Status": "MODIFIED", // Status da ação
  "StatusDetail": "Devolução de item - pagamento ajustado", // Mais detalhes sobre o status da ação
  "AdId": 44332, // ID do anúncio
  "Payout": 10.50, // Pagamento da ação ao parceiro, na moeda do parceiro
  "DeltaPayout": -5.00, // Valor do pagamento corrigido em relação à ação anterior
  "IntendedPayout": 15.50, // Valor de pagamento previsto para uma ação acima do limite
  "Amount": 100.00, // Valor da ação, na moeda da conta
  "DeltaAmount": -50.00, // Valor corrigido em relação à ação anterior
  "IntendedAmount": 150.00, // Valor de venda previsto para uma ação acima do limite
  "Currency": "USD", // Moeda da ação
  "OriginalCurrency": "USD", // Moeda original (ou seja, do carrinho) da ação
  "OriginalAmount": 100.00, // Valor original (ou seja, do carrinho) da ação
  // Coleção "items": dados de cada item desta ação
  "items": [{join(items, i, 
  "\{\"sku\":\"{i.sku}\",
  \"item_price\":{i.amt},
  \"category\":\"{i.cat}\",
  \"quantity\":{i.qty},
  \"cartamt\":{i.cartamt},
  \"rbt\":\"{i.rbt}\",
  \"name\":\"{i.name}\"\}")}],
  "EventDate": "2026-04-08T09:00:00Z", // Data da conversão
  "CreationDate": "2026-04-08T09:05:00Z", // Data de criação no sistema
  "LockingDate": "2026-05-08T00:00:00Z", // Data em que a ação será bloqueada
  "ClearedDate": "2026-05-15T00:00:00Z", // Data prevista para a liberação
  "ReferringDomain": "blog.partner.com", // Domínio de referência
  "LandingPageUrl": "https://brand.com/sale", // URL da página de destino
  "RefCustomerArea": "California", // Área do cliente (derivada do IP)
  "RefCustomerCity": "San Francisco", // Cidade do cliente (derivada do IP)
  "RefCustomerRegion": "CA", // Região do cliente (derivada do IP)
  "RefCustomerCountry": "US", // Código do país do cliente (derivado do IP)
  "RefClickId": "CLK9988776655", // Identificador exclusivo do clique
  "SharedId": "social_post_01", // ID compartilhado do parceiro
  "PromoCode": "SAVE20", // Código promocional geral
  "CustomerStatus": "EXISTING", // Status do cliente
  "Oid": "ORD-554433", // ID do pedido
  "Note": "Partial return processed", // Observação fornecida com a ação
  "CustomerPostCode": "94105", // Código postal do cliente
  "CustomerCity": "San Francisco", // Cidade do cliente
  "CustomerCountry": "US", // Código do país do cliente
  "CustomerRegion": "CA", // Região do cliente
  "CustomerId": "CUST-12345", // ID do cliente
  "CustomerEmail": "a665a45920422f9d417...", // E-mail do cliente com hash
  "IpAddress": "192.168.1.1", // Endereço IP
  "CallerId": null, // Número de telefone de quem ligou
  // Campos suplementares personalizados
  "Text1": "Custom Val 1", // Texto 1
  "Date1": "2026-04-08", // Data 1
  "Money1": 10.00, // Valor monetário 1
  "Numeric1": 1, // Numérico 1
  // Metadados do dispositivo e do app
  "appPackage": "com.brand.app", // Pacote do aplicativo móvel
  "appName": "BrandStore", // Nome do aplicativo móvel
  "appVersion": "4.2.1", // Versão do aplicativo móvel
  "deviceOs": "iOS", // Sistema operacional do dispositivo
  "deviceOsVersion": "17.4", // Versão do sistema operacional do dispositivo
  "deviceManuf": "Apple", // Fabricante do dispositivo
  "deviceModel": "iPhone 15", // Modelo do dispositivo
  "macAddress": "00:1B:44:11:3A:B7", // Endereço MAC (maiúsculas)
  "macAddressLower": "00:1b:44:11:3a:b7", // Endereço MAC (minúsculas)
  "macAddressAlpha": "001B44113AB7", // Endereço MAC (sem dois-pontos)
  "macAddressSha1": "47a32...", // SHA-1 do MAC
  "iosIfa": "EA7583CD-A667-48BC-B806-42ECB2B48606", // ID de publicidade do iOS
  "iosAdTracking": "1", // Configuração de rastreamento de anúncios do iOS
  "androidId": null, // ID do Android
  "deviceId": "D-556677", // ID do dispositivo
  "deviceIp": "192.168.1.1" // IP do dispositivo
}
```

</details>

<details>

<summary>Eventos de consulta de ação</summary>

Os eventos de consulta de ação enviarão uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros incluídos) quando consultas de ação forem criadas ou resolvidas.

```json
// Um exemplo de POST no formato JSON
{
  "Id": 554433, // Identificador exclusivo da consulta de ação no sistema
  "MediaPartnerId": 555, // ID do parceiro
  "MediaPartnerName": "Top Tier Affiliates", // Nome do parceiro
  "CampaignId": 9876, // ID do programa
  "CampaignName": "Spring Global Promotion", // Nome do programa
  "OrderId": "ORD-12345", // ID do pedido da ação relatada
  "TransactionDate": "2026-04-01T14:30:00Z", // Data da transação do evento que acionou a consulta de ação
  "TransactionAmount": 250.00, // Valor da transação do evento que acionou a consulta de ação
  "InquiryType": "MISSING_ACTION", // Tipo de consulta de ação
  "ExpectedPayout": 25.00, // Valor do pagamento esperado pelo parceiro
  "ResolutionDeadlineDate": "2026-05-01T00:00:00Z", // Data limite para aceitar ou recusar a consulta
  "TrackingLink": "https://proweb.com/click?cid=1&pid=555", // Link de rastreamento fornecido pelo parceiro
  "ActionId": "ACT-999000", // ID da ação (se associada a uma ação existente)
  "AutoApprovalDate": "2026-05-05T00:00:00Z", // Data em que o sistema executará as regras de aprovação automática
  "ResolutionStatus": "PENDING", // Status final da consulta de ação
  "RejectReason": null, // Motivo da rejeição da consulta de ação
  "FinalPayout": 0.00, // Pagamento final associado à consulta de ação
  "ResolutionDate": null, // Data em que a consulta foi decidida
  "CreationDate": "2026-04-08T10:05:00Z", // Data em que a consulta foi criada no sistema
  "InquiryNotes": "Customer claims they clicked the link but no credit was shown.", // Observações da consulta enviadas pelo parceiro
  "ResolutionNotes": null, // Observações enviadas quando a consulta foi decidida
  "Comments": "[{\"user\": \"support_agent\", \"text\": \"Verifying click logs now.\"}, {\"user\": \"partner\", \"text\": \"Customer provided receipt.\"}]" // Comentários adicionados à consulta (em formato JSON)
}
```

</details>

<details>

<summary>Eventos de liquidação de ação</summary>

Os eventos de liquidação de ação enviarão uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros incluídos) quando as ações forem liquidadas.

```json
// Um exemplo de POST no formato JSON
{
  "ActionTrackerId": 12345, // ID do tipo de evento
  "ActionTrackerName": "Standard Sale Tracker", // Nome do tipo de evento
  "CampaignId": 9876, // ID do programa
  "CampaignName": "Spring Global Promotion", // Nome do programa
  "MediaPartnerId": 555, // ID do parceiro
  "MediaPartnerName": "Top Tier Affiliates", // Nome do parceiro
  "OrderIds": "ORD-9921,ORD-9922", // IDs dos pedidos das ações relatadas (separados por vírgula)
  "ActionIds": "ACT-101,ACT-102", // IDs das ações (separados por vírgula)
  "ClearedDate": "2026-04-15T12:00:00Z", // Data (ISO 8601) em que a ação está programada para ser liquidada
  "LedgerDate": "2026-04-08T09:54:43Z" // Data (ISO 8601) em que a ação foi liquidada
}
```

</details>

<details>

<summary>Eventos de solicitação de valor de rastreamento</summary>

Os eventos de solicitação de valor de rastreamento enviarão uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros incluídos) quando solicitações de rastreamento forem criadas.

```json
// Um exemplo de POST no formato JSON
{
  "CampaignId": 9876, // ID do programa
  "ActionTrackerId": 12345, // ID do tipo de evento
  "MediaPartnerId": 555, // ID do parceiro
  "ActionId": "ACT-778899", // ID da ação
  "Amount": 150.00, // Valor da ação na moeda da conta
  "Currency": "USD", // Moeda da ação
  "Oid": "ORD-554433", // ID do pedido
  // Coleção "items": detalhamento dos produtos individuais na ação
  "items": [{join(items, i, "\{\"sku\":\"{i.sku}\",\"item_price\":{i.amt},\"category\":\"{i.cat}\",\"quantity\":{i.qty},\"cartamt\":{i.cartamt},\"rbt\":\"{i.rbt}\",\"name\":\"{i.name}\"\}")}],
  "EventDate": "2026-04-08T09:00:00Z", // Data da conversão
  "IpAddress": "192.168.1.1", // Endereço IP do dispositivo
  "RefClickId": "CLK9988776655" // Identificador exclusivo do clique
}
```

</details>

<details>

<summary>Eventos de trabalhos concluídos</summary>

Os eventos de trabalhos concluídos enviarão uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros adicionais) quando um trabalho for concluído para um [Exportação de relatório](https://integrations.impact.com/brand-api-reference/reference/report-export/report-export) ou [Clique em Exportar](https://integrations.impact.com/brand-api-reference/reference/clicks/clickexport).

```json
// Um exemplo de POST no formato JSON
{
  "JobId": 10293847, // ID exclusivo do trabalho
  "JobType": "REPORT_EXPORT", // Tipo de trabalho
  "AccountId": 7744, // ID da conta
  "StartDate": "2026-04-08T10:00:05Z", // Horário de início do trabalho
  "EndDate": "2026-04-08T10:11:02Z", // Horário de conclusão do trabalho
  "RecordsProcessed": 5240, // Número de registros processados ou gerados
  "ApiJobDetailUri": "https://api.impact.com/jobs/10293847", // URI da API para obter mais detalhes sobre o trabalho
  "ApiResultUri": "https://api.impact.com/jobs/10293847/result", // URI da API para obter o resultado da saída do trabalho
  "ResultDownloadUrlExp5": "https://download.impact.com/file?token=a1b2...&exp=5min", // URL para baixar a saída (expira em 5 minutos)
  "ResultDownloadUrlExp15": "https://download.impact.com/file?token=a1b2...&exp=15min", // URL para baixar a saída (expira em 15 minutos)
  "ResultDownloadUrlExp30": "https://download.impact.com/file?token=a1b2...&exp=30min", // URL para baixar a saída (expira em 30 minutos)
  "ResultDownloadUrlExp60": "https://download.impact.com/file?token=a1b2...&exp=60min" // URL para baixar a saída (expira em 60 minutos)
}
```

</details>

<details>

<summary>Eventos de candidatura de publisher</summary>

{% hint style="success" %}
**Observação:** Este recurso está em versão beta. Entre em contato com seu CSM ou com nossa [equipe de suporte](https://app.impact.com/support/portal.ihtml?createTicket=true&) se quiser testar este recurso.
{% endhint %}

Os eventos de candidatura de publisher enviarão uma solicitação HTTP para uma URL especificada quando um parceiro enviar uma candidatura e sempre que ela for aprovada, rejeitada ou retirada.

Os eventos de candidatura de publisher também são conhecidos como retorno de evento de contrato, webhook de processamento de candidaturas ou webhook de candidatura.

Se um payload `PENDING` for entregue com pontos de dados vazios, o sistema foi projetado para acionar atualizações à medida que as informações ficam disponíveis. As entregas subsequentes bem-sucedidas preencherão esses campos anteriormente vazios, garantindo que seus registros permaneçam sincronizados com as informações processadas mais recentes.

{% hint style="warning" %}
**Importante:** Se você tiver [fluxos de trabalho de candidatura](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/platform-features/review-partner-applications/automate-partner-application-processing.md) configurados, eles serão executados antes do disparo do webhook. O webhook será disparado com o *Status*: `APPROVED` ou `REJECTED` resultante, se um fluxo de trabalho tiver processado a candidatura; com `PENDING` se nenhum fluxo de trabalho tiver sido aplicado; ou com `RETRACTED` se o parceiro tiver retirado a candidatura.
{% endhint %}

Para ver como este webhook funciona em conjunto com o Recruitment Agent, consulte [Recruitment Agent](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/platform-features/review-partner-applications/recruitment-agent.md#see-where-the-agent-fits-with-your-existing-automation).

O conteúdo do payload varia de acordo com o *Status*. O exemplo abaixo mostra um evento `PENDING` com comentários indicando quais campos aparecem nos outros status.

```json
// Um exemplo de POST no formato JSON
{
  "Status": "PENDING", // Status da candidatura: PENDING, APPROVED, REJECTED, RETRACTED
  "ProgramId": "9876", // ID do programa
  "TemplateTermsId": "4455", // ID dos termos do modelo
  "ContractId": "112233", // ID do contrato
  "ApplicationDate": "2026-04-09T08:30:00Z", // Data da solicitação
  "PublisherSignerName": "Sarah Chen", // Usuário da editora que processou
  "PublisherId": "555", // ID do parceiro
  "Name": "Elite Content Creators", // Nome do parceiro
  "BusinessModel": "SOCIAL_INFLUENCER", // Principal modelo de negócios do parceiro
  "Address": "123 Marketing Way", // Endereço
  "City": "Los Angeles", // Cidade
  "State": "CA", // Estado
  "Country": "US", // País

  // Somente APPROVED, REJECTED ou RETRACTED
  "DecisionDate": null, // Data da decisão

  // Somente APPROVED
  "ContractStartDate": null, // Data de início do contrato

  // Somente REJECTED
  "DeclineReason": null, // Motivo da rejeição

  // Somente APPROVED ou REJECTED
  "AdvertiserSignerName": null, // Usuário do anunciante que processou

  // Somente PENDING: campos do perfil do parceiro
  "Description": "A premium network of lifestyle and travel influencers.", // Descrição do perfil do parceiro
  "Language": "en-US", // Idioma
  "PublisherSize": "M", // XS, S, M, L, XL
  "PastRelationship": "false", // Booleano que indica se houve contrato anterior
  "MarketplaceApproved": "true", // Booleano que indica o status no marketplace
  "ReceivedPayout": "true", // Booleano que indica se recebeu um pagamento

  // Somente PENDING: propriedades de mídia associadas ao parceiro
  "properties": [{join(properties, i, "{\"platform\":\"{i.platform}\",\"verified\":\"{i.verified}\",\"url\":\"{i.url}\",\"category\":\"{i.category}\",\"reach\":\"{i.reach}\",\"engagementRate\":\"{i.engagementRate}\",\"audienceCountryPct\":\"{i.audienceCountryPct}\",\"audienceGenderPct\":\"{i.audienceGenderPct}\",\"audienceAgeRangePct\":\"{i.audienceAgeRangePct}\"}")}],

  // Somente PENDING: campos demográficos do criador
  "CreatorIncome": "", // Renda familiar
  "CreatorGender": "", // Gênero
  "CreatorEthnicity": "", // Etnia
  "CreatorEducation": "", // Nível de escolaridade
  "CreatorRelationshipStatus": "", // Estado civil
  "CreatorParentalStatus": "", // Situação parental
  "CreatorPronouns": "", // Pronomes
  "CreatorDOB": "", // Data de nascimento

  // Somente PENDING: IDs dos grupos
  "GroupIds": "1001,1002,1003" // IDs dos grupos separados por vírgulas
}
```

</details>

## Mecanismo de novas tentativas de postback

Se um postback falhar ao tentar enviar uma solicitação para a URL de destino, o sistema tentará entregá-lo novamente automaticamente, seguindo um cronograma definido, por até 15 vezes. As novas tentativas ajudam a lidar com problemas temporários de rede ou indisponibilidade do servidor.

### Condições em que não haverá novas tentativas

O postback não será tentado novamente nos seguintes casos:

* A URL de destino está malformada ou é inválida.
* A URL de destino ou seu host não pode ser resolvido, por exemplo, devido a uma falha na consulta de DNS.

### Cronograma de novas tentativas

As tentativas seguem o cronograma abaixo. As tentativas 1, 2 e 3 são ignoradas se o código de resposta HTTP estiver no intervalo de `400` a `500`.

<details>

<summary>Referência do cronograma de novas tentativas</summary>

<table><thead><tr><th width="180.5390625">Tentativa</th><th>Intervalo antes da nova tentativa</th></tr></thead><tbody><tr><td>Nova tentativa 1</td><td>+15 segundos</td></tr><tr><td>Nova tentativa 2</td><td>+15 segundos</td></tr><tr><td>Nova tentativa 3</td><td>+15 segundos</td></tr><tr><td>Nova tentativa 4</td><td>+3 minutos</td></tr><tr><td>Nova tentativa 5</td><td>+3 minutos</td></tr><tr><td>Nova tentativa 6</td><td>+15 minutos</td></tr><tr><td>Nova tentativa 7</td><td>+15 minutos</td></tr><tr><td>Nova tentativa 8</td><td>+15 minutos</td></tr><tr><td>Nova tentativa 9</td><td>+2 horas</td></tr><tr><td>Nova tentativa 10</td><td>+2 horas</td></tr><tr><td>Nova tentativa 11</td><td>+2 horas</td></tr><tr><td>Nova tentativa 12</td><td>+6 horas</td></tr><tr><td>Nova tentativa 13</td><td>+6 horas</td></tr><tr><td>Nova tentativa 14</td><td>+6 horas</td></tr><tr><td>Nova tentativa 15</td><td>+6 horas</td></tr></tbody></table>

</details>


---

# 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/account-administration/account-settings/notifications/enable-event-notification-postbacks-for-brands.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.
