ウェブフック

ウェブフックを使用すると、リンクがクリックされたときにリアルタイム通知を受け取ることができます。クリックが発生すると、Linklyは指定されたURL(複数可)にPOSTリクエストを送信し、クリックに関する詳細情報を含めます。

ユースケース

• オートメーションプラットフォーム: リンクがクリックされたときにMakeまたはZapierのワークフローをトリガーします
• カスタム分析: クリックデータを独自の分析システムに送信します
• CRM更新: リンクをクリックしたときに顧客レコードを更新します
• Slack通知: 重要なリンクがクリックされたときにSlackで通知を受け取ります
• リード追跡: 見込み客がリンクにエンゲージメントしたときにトラッキングします

ヒント: ほとんどのオートメーションユースケースでは、カスタムウェブフックよりMake統合またはZapier統合の方が簡単にセットアップできます。コーディング不要で、ウェブフックによるインスタントクリックトリガーが含まれています。

注意: 両方のレベルでウェブフックを設定した場合、そのリンクへのクリック時に両方が実行されます。

ウェブフックペイロード

クリックが発生すると、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"
    }
  }
}

ペイロードフィールド

イベント情報

リンクオブジェクト

クリックオブジェクト

プライバシー注意: IPアドレスはウェブフックペイロードに含まれません。

オートメーションプラットフォーム統合

カスタムコーディングなしで簡単にセットアップするには、当社のネイティブ統合を使用してください:

• Make統合 - インスタントクリックトリガー機能を備えたビジュアルオートメーションプラットフォーム
• Zapier統合 - コード不要でLinklyを数千のアプリに接続します

どちらの統合もバックグラウンドでウェブフックを使用していますが、セットアップはすべて自動的に処理されます。

ベストプラクティス

複数のウェブフック

複数のウェブフックURL(1行に1つ)を追加できます。クリックが発生すると、すべてのURLが同じペイロードを受け取ります。

エラーハンドリング

• ウェブフックはファイアアンドフォーゲットです - Linklyは失敗した配信を再試行しません
• ウェブフックの失敗はリダイレクトに影響しません - ユーザーは常に宛先に到達します
• ウェブフックエンドポイントが迅速に応答することを確認してください(5秒未満を推奨)

セキュリティ

• ウェブフックURLはHTTPSエンドポイントを使用してください
• ウェブフックハンドラで受信リクエストを検証してください
• 検証のためにウェブフックURLにシークレットパラメータを追加することを検討してください

テスト

1. 1
   webhook.siteまたはRequestBinなどのサービスを使用してウェブフックURLをセットアップします
2. 2
   リンクをクリックします
3. 3
   受信したペイロードを確認します
4. 4
   検証後、本番環境のウェブフックURLに切り替えます

APIアクセス

API経由でウェブフックをプログラムで管理することもできます:

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ドキュメントを参照してください。