为品牌启用事件通知回传
事件通知回传（webhooks）会在特定事件发生时实时通知你的内部系统。虽然发送的数据会因事件而异，但所有事件的配置流程相同。
1
访问事件通知回传
从顶部导航栏中选择
[用户资料] → 设置.在 技术 部分中，选择 事件通知.
2
完成全局配置字段
将鼠标悬停在要配置通知回传的事件上，然后选择
[编辑].使用下表配置投递设置：
字段
说明
URL
你服务器上接收数据的端点。
HTTP 方法
GET：数据会作为查询字符串附加到 URL。
POST：数据会在请求正文中发送，其中包含你可以设置的各种可选参数。
请参阅 通知事件和负载 以了解每个事件及其负载内容的更多信息。
HTTP 头
（可选）添加用于身份验证的自定义头部（例如， Authorization: Bearer token).
最小延迟
将 最小延迟 设置为秒，以保护你的服务器免受流量峰值影响。
每秒最大请求数
将 每秒最大请求数 以保护你的服务器免受流量峰值影响。
成功响应
当回传被正确处理时，你的服务器返回的特定文本字符串或 HTTP 状态码。
错误响应
表示失败的文本字符串或状态码（例如， ERROR 或 500).
通知事件与负载
每个事件通知都会发送一组唯一的可配置数据点（例如， {ActionId}）。请参阅下面的事件，了解你可以从负载中提取哪些数据点。
动作生命周期事件
当动作被跟踪、修改或撤销时，动作生命周期事件会向指定的 URL（以及任何包含的参数）发出 HTTP 请求。
// JSON 格式的 POST 示例
{
"CampaignId": 9876, // 项目 ID
"ActionTrackerId": 12345, // 事件类型 ID
"MediaPartnerId": 555, // 合作伙伴 ID
"CampaignName": "Spring Global Promotion", // 项目名称
"ActionTrackerName": "Standard Sale Tracker", // 事件类型名称
"MediaPartnerName": "Top Tier Affiliates", // 合作伙伴名称
"ActionId": "ACT-778899", // 动作 ID
"Status": "MODIFIED", // 动作状态
"StatusDetail": "Item return - payout adjusted", // 关于动作状态的更多详情
"AdId": 44332, // 广告 ID
"Payout": 10.50, // 支付给合作伙伴的动作佣金，使用合作伙伴的货币
"DeltaPayout": -5.00, // 佣金金额的变更
"IntendedPayout": 15.50, // 超限动作的预期佣金金额
"Amount": 100.00, // 动作金额，使用账户货币
"DeltaAmount": -50.00, // 来自前一个动作的修正金额
"IntendedAmount": 150.00, // 超限动作的预期销售金额
"Currency": "USD", // 动作货币
"OriginalCurrency": "USD", // 动作原始（即购物车）货币
"OriginalAmount": 100.00, // 动作原始（即购物车）金额
// "items" 集合：此动作中各个商品的数据
"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", // 转化日期
"CreationDate": "2026-04-08T09:05:00Z", // 在系统中创建的日期
"LockingDate": "2026-05-08T00:00:00Z", // 动作将被锁定的日期
"ClearedDate": "2026-05-15T00:00:00Z", // 计划清算的日期
"ReferringDomain": "blog.partner.com", // 引荐域名
"LandingPageUrl": "https://brand.com/sale", // 落地页 URL
"RefCustomerArea": "California", // 客户地区（IP 推导）
"RefCustomerCity": "San Francisco", // 客户城市（IP 推导）
"RefCustomerRegion": "CA", // 客户区域（IP 推导）
"RefCustomerCountry": "US", // 客户国家代码（IP 推导）
"RefClickId": "CLK9988776655", // 唯一点击标识符
"SharedId": "social_post_01", // 合作伙伴共享 ID
"PromoCode": "SAVE20", // 通用促销代码
"CustomerStatus": "EXISTING", // 客户状态
"Oid": "ORD-554433", // 订单 ID
"Note": "Partial return processed", // 随动作提供的备注
"CustomerPostCode": "94105", // 客户邮政编码
"CustomerCity": "San Francisco", // 客户城市
"CustomerCountry": "US", // 客户国家代码
"CustomerRegion": "CA", // 客户区域
"CustomerId": "CUST-12345", // 客户 ID
"CustomerEmail": "a665a45920422f9d417...", // 已哈希处理的客户电子邮件
"IpAddress": "192.168.1.1", // IP 地址
"CallerId": null, // 来电者电话号码
// 自定义补充字段
"Text1": "Custom Val 1", // 文本 1
"Date1": "2026-04-08", // 日期 1
"Money1": 10.00, // 金额 1
"Numeric1": 1, // 数值 1
// 设备和应用元数据
"appPackage": "com.brand.app", // 移动应用包名
"appName": "BrandStore", // 移动应用名称
"appVersion": "4.2.1", // 移动应用版本
"deviceOs": "iOS", // 设备操作系统
"deviceOsVersion": "17.4", // 设备操作系统版本
"deviceManuf": "Apple", // 设备制造商
"deviceModel": "iPhone 15", // 设备型号
"macAddress": "00:1B:44:11:3A:B7", // MAC 地址（大写）
"macAddressLower": "00:1b:44:11:3a:b7", // MAC 地址（小写）
"macAddressAlpha": "001B44113AB7", // MAC 地址（无冒号）
"macAddressSha1": "47a32...", // MAC SHA1
"iosIfa": "EA7583CD-A667-48BC-B806-42ECB2B48606", // iOS 广告 ID
"iosAdTracking": "1", // iOS 广告跟踪设置
"androidId": null, // Android ID
"deviceId": "D-556677", // 设备 ID
"deviceIp": "192.168.1.1" // 设备 IP
}动作查询事件
当创建或解决动作查询时，动作查询事件会向指定的 URL（以及任何包含的参数）发出 HTTP 请求。
// JSON 格式的 POST 示例
{
"Id": 554433, // 系统中该动作查询的唯一标识符
"MediaPartnerId": 555, // 合作伙伴 ID
"MediaPartnerName": "Top Tier Affiliates", // 合作伙伴名称
"CampaignId": 9876, // 项目 ID
"CampaignName": "Spring Global Promotion", // 项目名称
"OrderId": "ORD-12345", // 所报告动作的订单 ID
"TransactionDate": "2026-04-01T14:30:00Z", // 触发动作查询的事件交易日期
"TransactionAmount": 250.00, // 触发动作查询的事件交易金额
"InquiryType": "MISSING_ACTION", // 动作查询类型
"ExpectedPayout": 25.00, // 合作伙伴预期的佣金金额
"ResolutionDeadlineDate": "2026-05-01T00:00:00Z", // 查询必须被接受或拒绝的日期
"TrackingLink": "https://proweb.com/click?cid=1&pid=555", // 合作伙伴提供的跟踪链接
"ActionId": "ACT-999000", // 动作 ID（如果与现有动作相关联）
"AutoApprovalDate": "2026-05-05T00:00:00Z", // 系统将运行自动审批规则的日期
"ResolutionStatus": "PENDING", // 该动作查询的最终处理状态
"RejectReason": null, // 动作查询被拒绝的原因
"FinalPayout": 0.00, // 与动作查询关联的最终佣金
"ResolutionDate": null, // 查询被决定的日期
"CreationDate": "2026-04-08T10:05:00Z", // 查询在系统中创建的日期
"InquiryNotes": "Customer claims they clicked the link but no credit was shown.", // 合作伙伴提交的查询备注
"ResolutionNotes": null, // 查询被决定时提交的备注
"Comments": "[{\"user\": \"support_agent\", \"text\": \"Verifying click logs now.\"}, {\"user\": \"partner\", \"text\": \"Customer provided receipt.\"}]" // 添加到查询中的评论（JSON 格式）
}动作清算事件
当动作被清算时，动作清算事件会向指定的 URL（以及任何包含的参数）发出 HTTP 请求。
// JSON 格式的 POST 示例
{
"ActionTrackerId": 12345, // 事件类型 ID
"ActionTrackerName": "Standard Sale Tracker", // 事件类型名称
"CampaignId": 9876, // 项目 ID
"CampaignName": "Spring Global Promotion", // 项目名称
"MediaPartnerId": 555, // 合作伙伴 ID
"MediaPartnerName": "Top Tier Affiliates", // 合作伙伴名称
"OrderIds": "ORD-9921,ORD-9922", // 所报告动作的订单 ID（以逗号分隔）
"ActionIds": "ACT-101,ACT-102", // 动作 ID（以逗号分隔）
"ClearedDate": "2026-04-15T12:00:00Z", // 计划清算动作的日期（ISO 8601）
"LedgerDate": "2026-04-08T09:54:43Z" // 动作被清算的日期（ISO 8601）
}跟踪值请求事件
当创建跟踪请求时，跟踪值请求事件会向指定的 URL（以及任何包含的参数）发出 HTTP 请求。
// JSON 格式的 POST 示例
{
"CampaignId": 9876, // 项目 ID
"ActionTrackerId": 12345, // 事件类型 ID
"MediaPartnerId": 555, // 合作伙伴 ID
"ActionId": "ACT-778899", // 动作 ID
"Amount": 150.00, // 账户货币中的动作金额
"Currency": "USD", // 动作货币
"Oid": "ORD-554433", // 订单 ID
// "items" 集合：动作中各个产品的明细
"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", // 转化日期
"IpAddress": "192.168.1.1", // 设备的 IP 地址
"RefClickId": "CLK9988776655" // 唯一点击标识符
}回传重试机制
如果回传在向目标 URL 发布时失败，投递将根据设定计划自动重试，最多 15 次。重试有助于应对临时网络问题或服务器不可用。
不会重试的情况
在以下情况下，回传不会重试：
目标 URL 格式错误或无效。
目标 URL 或其主机无法解析，例如由于 DNS 查询失败。
重试计划
重试尝试遵循以下计划。如果 HTTP 响应代码处于 400 到 500.
最后更新于
这有帮助吗？