ウェブフック

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

ユースケース

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

ヒント: ほとんどの自動化ユースケースでは、カスタムウェブフックよりもMake統合またはZapier統合の方が設定が簡単です。コーディング不要で、ウェブフックによるインスタントクリックトリガーが含まれています。

注意: 両方のレベルでウェブフックを設定した場合、そのリンクのクリックに対して両方が発火します。

イベント

すべてのウェブフックは、そのスコープのすべてのイベントタイプを受け取ります。リンクレベルのウェブフックはそのリンクのイベント、ワークスペースレベルのウェブフックはワークスペース内のすべてのリンクのイベントを受け取ります。トップレベルのeventフィールドをチェックして区別します。

ウェブフックペイロード

クリックペイロード

クリックが発生すると、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": {
    "id": "01KYPGEEPJSPR3S564QRBDGA1W",
    "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アドレスはウェブフックペイロードに含まれることはありません。

リンクライフサイクルペイロード

link.created、link.updated、およびlink.deletedイベントは1つの形式を共有します。clickオブジェクトはありません。event、timestamp、および完全なlinkを取得します。

{
  "event": "link.created",
  "timestamp": "2026-06-20T10: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",
    "workspace_id": 1,
    "enabled": true,
    "rules": []
  }
}

自動化プラットフォーム統合

カスタムコーディングなしで簡単に設定するには、ネイティブ統合を使用します。

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