Webhooks

Webhooks 允许您在链接被点击时接收实时通知。当点击发生时，Linkly 会向您指定的 URL 发送 POST 请求，其中包含有关点击的详细信息。

使用场景

• 自动化平台：在链接被点击时触发 Make 或 Zapier 中的工作流
• 自定义分析：将点击数据发送到您自己的分析系统
• CRM 更新：在客户点击链接时更新客户记录
• Slack 通知：在重要链接被点击时在 Slack 中接收通知
• 潜在客户跟踪：跟踪潜在客户何时与您的链接互动

提示：对于大多数自动化用例，我们的 Make 集成或 Zapier 集成比自定义 webhooks 更容易设置。它们包含由 webhooks 驱动的即时点击触发器，无需编码。

注意：如果您在两个级别都配置了 webhooks，则该链接的点击将同时触发两者。

Webhook 有效负载

当点击发生时，Linkly 会发送包含以下 JSON 有效负载的 POST 请求：

{
  "event": "click",
  "timestamp": "2025-01-15T10:30:00Z",
  "link": {
    "id": 12345,
    "name": "My Campaign Link",
    "url": "https://example.com/landing-page",
    "full_url": "https://yourdomain.com/abc123",
    "domain": "yourdomain.com",
    "slug": "/abc123",
    "destination": "https://example.com/landing-page",
    "workspace_id": 1,
    "enabled": true,
    "cloaking": false,
    "forward_params": true,
    "block_bots": true,
    "public_analytics": false,
    "utm_source": "newsletter",
    "utm_medium": "email",
    "utm_campaign": "spring-sale",
    "og_title": "Special Offer",
    "og_description": "Check out our spring sale!",
    "rules": [
      {
        "what": "country",
        "matches": "US",
        "url": "https://example.com/us-landing"
      }
    ]
  },
  "click": {
    "country": "US",
    "is_eu_country": false,
    "platform": "desktop",
    "browser_name": "Chrome",
    "referer": "https://twitter.com/",
    "isp": "Comcast",
    "bot_name": null,
    "destination": "https://example.com/landing-page",
    "params": {
      "utm_source": "twitter"
    }
  }
}

有效负载字段

事件信息

链接对象

点击对象

隐私说明：webhook 有效负载中从不包含 IP 地址。

自动化平台集成

为了更轻松地设置而无需自定义编码，请使用我们的原生集成：

• Make 集成 - 带有即时点击触发器的可视化自动化平台
• Zapier 集成 - 无需代码即可将 Linkly 连接到数千个应用

这两个集成都在底层使用 webhooks，但会自动处理所有设置。

最佳实践

多个 Webhooks

您可以添加多个 webhook URL（每行一个）。当点击发生时，所有 URL 都会收到相同的有效负载。

错误处理

• Webhooks 是即发即弃的 - Linkly 不会重试失败的传递
• Webhook 失败永远不会影响重定向 - 用户始终会到达其目的地
• 确保您的 webhook 端点快速响应（建议 < 5 秒）

安全性

• 为 webhook URL 使用 HTTPS 端点
• 在 webhook 处理程序中验证传入请求
• 考虑在 webhook URL 中添加秘密参数以进行验证

测试

1. 1
   使用 webhook.site 或 RequestBin 等服务设置 webhook URL
2. 2
   点击您的链接
3. 3
   检查收到的有效负载
4. 4
   验证后，切换到您的生产 webhook URL

API 访问

您还可以通过 API 以编程方式管理 webhooks：

POST   /api/v1/link/:link_id/webhooks
DELETE /api/v1/link/:link_id/webhooks/:hook_id
GET    /api/v1/link/:link_id/webhooks

POST   /api/v1/workspace/:workspace_id/webhooks
DELETE /api/v1/workspace/:workspace_id/webhooks/:hook_id
GET    /api/v1/workspace/:workspace_id/webhooks

详情请参阅 API 文档。