> 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 *Técnico* , selecione [**Notificações de eventos**](https://app.impact.com/secure/advertiser/accountSettings/techintegration/view-edit-adv-pingback-settings-flow.ihtml?). {% endstep %} {% step %} ## Preencha os campos de configuração global 1. Passe o mouse sobre o evento para o qual você 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 definições de entrega:
CampoDescrição
URLO endpoint no seu servidor que receberá os dados.
Método HTTP

GET: Os dados são anexados à URL como strings de consulta.

POST: Os dados são enviados no corpo da solicitação, que inclui vários parâmetros opcionais que você pode definir.

Consulte Eventos de notificação e payloads para obter mais informações sobre cada evento e o conteúdo do payload.

Cabeçalho HTTP(Opcional) Adicione cabeçalhos personalizados para autenticação (por exemplo, Authorization: Bearer token).
Atraso mínimoDefina Atraso mínimo em segundos para proteger seu servidor contra picos de tráfego.
Número máximo de solicitaçõesDefina Número máximo de solicitações por segundo para proteger seu servidor contra picos de tráfego.
Resposta de sucessoA string de texto específica ou o código de status HTTP que seu servidor retorna quando um postback é tratado corretamente.
Resposta de erroA string de texto ou código de status que indica uma falha (por exemplo, ERROR ou 500).
{% 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.
Eventos do ciclo de vida da ação Os Eventos do ciclo de vida da ação enviarão uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros incluídos) quando uma ação for rastreada, modificada ou revertida. ```json // Exemplo de POST em 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": "Item return - payout adjusted", // Mais detalhes sobre o status da ação "AdId": 44332, // ID do anúncio "Payout": 10.50, // Pagamento da ação para o parceiro, na moeda do parceiro "DeltaPayout": -5.00, // Valor de pagamento corrigido da ação anterior "IntendedPayout": 15.50, // O valor de pagamento pretendido para uma ação acima do limite "Amount": 100.00, // Valor da ação, na moeda da conta "DeltaAmount": -50.00, // Valor corrigido da ação anterior "IntendedAmount": 150.00, // O valor de venda pretendido 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 itens individuais nesta 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 criada no sistema "LockingDate": "2026-05-08T00:00:00Z", // Data em que a ação será bloqueada "ClearedDate": "2026-05-15T00:00:00Z", // Data agendada para liquidaçã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 de 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, // Dinheiro 1 "Numeric1": 1, // Numérico 1 // Metadados do dispositivo e do aplicativo "appPackage": "com.brand.app", // Pacote do app mobile "appName": "BrandStore", // Nome do app mobile "appVersion": "4.2.1", // Versão do app mobile "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úsculo) "macAddressLower": "00:1b:44:11:3a:b7", // Endereço MAC (minúsculo) "macAddressAlpha": "001B44113AB7", // Endereço MAC (sem dois-pontos) "macAddressSha1": "47a32...", // MAC SHA1 "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 } ```
Eventos de solicitação de ação Os Eventos de solicitação de ação enviarão uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros incluídos) quando solicitações de ação forem criadas ou resolvidas. ```json // Exemplo de POST em formato JSON { "Id": 554433, // Identificador exclusivo da solicitação 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 disparou a solicitação de ação "TransactionAmount": 250.00, // Valor da transação do evento que disparou a solicitação de ação "InquiryType": "MISSING_ACTION", // Tipo de solicitação de ação "ExpectedPayout": 25.00, // Valor de pagamento esperado pelo parceiro "ResolutionDeadlineDate": "2026-05-01T00:00:00Z", // Data até a qual a solicitação deve ser aceita ou recusada "TrackingLink": "https://proweb.com/click?cid=1&pid=555", // Link de rastreamento fornecido pelo parceiro "ActionId": "ACT-999000", // ID da ação (se associado 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 de resolução da solicitação de ação "RejectReason": null, // Motivo pelo qual a solicitação de ação foi rejeitada "FinalPayout": 0.00, // Pagamento final associado à solicitação de ação "ResolutionDate": null, // Data em que a solicitação foi decidida "CreationDate": "2026-04-08T10:05:00Z", // Data em que a solicitação é criada no sistema "InquiryNotes": "Customer claims they clicked the link but no credit was shown.", // Observações da solicitação enviadas pelo parceiro "ResolutionNotes": null, // Observações enviadas quando a solicitação foi decidida "Comments": "[{\"user\": \"support_agent\", \"text\": \"Verificando os registros de clique agora.\"}, {\"user\": \"partner\", \"text\": \"O cliente forneceu o comprovante.\"}]" // Comentários adicionados à solicitação (em formato JSON) } ```
Eventos de liquidação de ações Os Eventos de liquidação de ações enviarão uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros incluídos) quando as ações forem liquidadas. ```json // Exemplo de POST em 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 } ```
Eventos de solicitação de valor de rastreamento 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 // Exemplo de POST em 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 de clique } ```
Eventos de trabalho concluído Os Eventos de trabalho concluído enviarão uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros adicionais) quando um trabalho tiver sido 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 // Exemplo de POST em 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", // Hora em que o trabalho foi iniciado "EndDate": "2026-04-08T10:11:02Z", // Hora em que o trabalho foi concluído "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ção de 5 minutos) "ResultDownloadUrlExp15": "https://download.impact.com/file?token=a1b2...&exp=15min", // URL para baixar a saída (expiração de 15 minutos) "ResultDownloadUrlExp30": "https://download.impact.com/file?token=a1b2...&exp=30min", // URL para baixar a saída (expiração de 30 minutos) "ResultDownloadUrlExp60": "https://download.impact.com/file?token=a1b2...&exp=60min" // URL para baixar a saída (expiração de 60 minutos) } ```
Eventos de aplicação do publicador {% hint style="success" %} **Observação:** Esta funcionalidade está em beta. Entre em contato com seu CSM ou com o nosso [equipe de suporte](https://app.impact.com/support/portal.ihtml?createTicket=true&) se você quiser testar este recurso. {% endhint %} Os Eventos de aplicação do publicador enviarão uma solicitação HTTP para uma URL especificada quando um parceiro enviar uma candidatura e cada vez que a candidatura for aprovada, rejeitada ou retirada. Os Eventos de aplicação do publicador também são conhecidos como postback do evento de contrato, webhook de processamento da candidatura ou webhook da candidatura. Se um `PENDING` payload for entregue com pontos de dados vazios, o sistema foi projetado para acionar atualizações à medida que as informações ficam disponíveis. Entregas bem-sucedidas subsequentes 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 da candidatura](/brand/pt-br/what-would-you-like-to-learn-about/platform-features/review-partner-applications/automate-partner-application-processing.md) configurados, eles são executados antes que o webhook seja disparado. O webhook é disparado com o resultado *Status*: `APPROVED` ou `REJECTED` se um fluxo de trabalho processou a candidatura, `PENDING` se nenhum fluxo de trabalho foi aplicado, ou `RETRACTED` se o parceiro retirou a candidatura. {% endhint %} Para ver como este webhook funciona junto com o Agente de Recrutamento, consulte [Agente de Recrutamento](/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 conforme o *Status*. O exemplo abaixo mostra um `PENDING` evento, com comentários indicando quais campos aparecem para outros status. ```json // Exemplo de POST em 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 candidatura "PublisherSignerName": "Sarah Chen", // Nome do usuário publisher que processou "PublisherId": "555", // ID do publicador "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, 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, REJECTED "AdvertiserSignerName": null, // Usuário do anunciante que processou // Somente PENDING: campos de 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 contrato anterior "MarketplaceApproved": "true", // Booleano que indica o status no marketplace "ReceivedPayout": "true", // Booleano que indica se receberam 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": "", // Status de relacionamento "CreatorParentalStatus": "", // Status parental "CreatorPronouns": "", // Pronomes "CreatorDOB": "", // Data de nascimento // Somente PENDING: IDs dos grupos "GroupIds": "1001,1002,1003" // IDs dos grupos separados por vírgula } ```
## Mecanismo de nova tentativa de postback Se um postback falhar ao tentar publicar na URL de destino, a entrega será tentada novamente automaticamente com base em um cronograma definido, até 15 vezes. As novas tentativas ajudam a lidar com problemas temporários de rede ou indisponibilidade do servidor. ### Condições em que as novas tentativas não ocorrerão Um postback não tentará novamente nos seguintes casos: * A URL de destino está malformada ou é inválida. * A URL de destino ou seu host não resolve, por exemplo, devido a uma falha na consulta DNS. ### Cronograma de novas tentativas As tentativas de retry seguem o cronograma abaixo. As tentativas 1, 2 e 3 são ignoradas se o código de resposta HTTP estiver na faixa de `400` para `500`.
Referência do cronograma de novas tentativas
Tentativa de retryAtraso antes da nova tentativa
Tentativa 1+15 segundos
Tentativa 2+15 segundos
Tentativa 3+15 segundos
Tentativa 4+3 minutos
Tentativa 5+3 minutos
Tentativa 6+15 minutos
Tentativa 7+15 minutos
Tentativa 8+15 minutos
Tentativa 9+2 horas
Tentativa 10+2 horas
Tentativa 11+2 horas
Tentativa 12+6 horas
Tentativa 13+6 horas
Tentativa 14+6 horas
Tentativa 15+6 horas
--- # 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=&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.