Ativar postbacks de notificação 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 conforme o evento, o processo de configuração é o mesmo para todos.
Acesse os postbacks de notificação de eventos
Na barra de navegação superior, selecione
[Perfil do usuário] → Configurações.Em Técnico seção, selecione Notificações de evento.
Preencha os campos de configuração global
Passe o mouse sobre o evento para o qual você quer configurar um postback de notificação e selecione
[Editar].Use a tabela abaixo para configurar as definições de entrega:
URL
O endpoint no seu servidor que receberá os dados.
Método HTTP
GET: Os dados são adicionados à 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 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ínimo
Defina Atraso mínimo em segundos para proteger seu servidor contra picos de tráfego.
Número máximo de solicitações
Defina Número máximo de solicitações por segundo para proteger seu servidor contra picos de tráfego.
Resposta de sucesso
A string de texto específica ou o código de status HTTP que seu servidor retorna quando um postback é processado corretamente.
Resposta de erro
A string de texto ou código de status que indica uma falha (por exemplo, ERROR ou 500).
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.
// Um 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": "Devolução do 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, // A alteração do valor do pagamento
"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
// "items" collection: 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 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 programada para compensaçã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 único 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 criptografado do cliente
"IpAddress": "192.168.1.1", // Endereço IP
"CallerId": null, // Número de telefone do chamador
// 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 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 SO 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...", // SHA1 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
}Eventos de consulta de ação
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.
// Um exemplo de POST em formato JSON
{
"Id": 554433, // Identificador único 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 reportada
"TransactionDate": "2026-04-01T14:30:00Z", // Data da transação do evento que disparou a consulta de ação
"TransactionAmount": 250.00, // Valor da transação do evento que disparou a consulta de ação
"InquiryType": "MISSING_ACTION", // Tipo de consulta de ação
"ExpectedPayout": 25.00, // Valor de pagamento esperado pelo parceiro
"ResolutionDeadlineDate": "2026-05-01T00:00:00Z", // A data até a qual a consulta 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", // A data em que o sistema executará as regras de aprovação automática
"ResolutionStatus": "PENDING", // Status final da resolução da consulta de ação
"RejectReason": null, // Motivo pelo qual a consulta de ação foi rejeitada
"FinalPayout": 0.00, // Pagamento final associado à consulta de ação
"ResolutionDate": null, // A data em que a consulta foi decidida
"CreationDate": "2026-04-08T10:05:00Z", // Data em que a consulta é 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\": \"Verificando os logs de cliques agora.\"}, {\"user\": \"partner\", \"text\": \"O cliente forneceu o recibo.\"}]" // Comentários adicionados à consulta (em formato JSON)
}Eventos de compensação da ação
Os Eventos de compensação da ação enviarão uma solicitação HTTP para uma URL especificada (e quaisquer parâmetros incluídos) quando as ações forem compensadas.
// Um 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 reportadas (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 compensada
"LedgerDate": "2026-04-08T09:54:43Z" // Data (ISO 8601) em que a ação foi compensada
}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.
// Um 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
// "items" collection: 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 único do 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 ou Clique em Exportar.
Eventos da candidatura do parceiro
Observação: Esta funcionalidade está em beta. Entre em contato com seu CSM ou com o nosso equipe de suporte se você quiser testar este recurso.
Os Eventos da candidatura do parceiro 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.
Se um PENDING payload for entregue com pontos de dados vazios, o sistema foi projetado para disparar atualizações à medida que as informações se tornam disponíveis. Entregas subsequentes bem-sucedidas preencherão esses campos anteriormente vazios, garantindo que seus registros permaneçam sincronizados com as informações processadas mais recentes.
Importante: Se você tiver fluxos de trabalho da candidatura configurados, eles são executados antes de o webhook ser 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.
O conteúdo do payload varia conforme Status. O exemplo abaixo mostra um PENDING evento, com comentários indicando quais campos aparecem para outros status.
Mecanismo de nova tentativa de postback
Se um postback falhar ao tentar publicar na URL de destino, a entrega será repetida 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 de consulta DNS.
Cronograma de novas tentativas
As tentativas de nova tentativa 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 para 500.
Referência do cronograma de novas tentativas
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
Atualizado
Isto foi útil?