クイックスタート
速報が発生したときに即時通知を受け取りましょう。Webhook はリアルタイムの記事更新をアプリケーションへ直接配信し、絶え間ない API ポーリングを不要にします。
Webhook とは?
Webhook はアプリケーション向けの即時通知だと考えてください。あなたの条件に一致するニュースが発生すると、finlight はただちに記事データを指定したエンドポイントへ送信します。
Webhook の仕組み
簡単に言うと、全体の流れは次のとおりです:
- 設定 - 特定のニュース条件で webhook を設定します
- 監視 - 当社のシステムが新しい記事を 24 時間 365 日監視します
- マッチ - 記事が条件を満たすと、即座に検知します
- 配信 - 記事データを直接あなたのエンドポイントへ送信します
この**「リバース API」**方式により、繰り返しリクエストするのではなく、更新が発生した瞬間にアプリケーションが受け取れます。
はじめに
必要なもの
最初の webhook を作成する前に、次のものを用意してください:
- webhook アクセスを含む有効な finlight サブスクリプション
- webhook の呼び出しを受け取れる公開 HTTPS エンドポイント
- app.finlight.me でのダッシュボードアクセス
クイックアクセス
app.finlight.me/news-webhooks にアクセスして finlight アカウントにログインすると、webhook の作成に直接進めます。
最初の Webhook を作成する
このシンプルな 4 ステップの手順に従って webhook を設定し、リアルタイムのニュース更新の受信を開始しましょう。
ステップ 1: Webhook クリエーターにアクセスする
- app.finlight.me で finlight ダッシュボードにログインします
- メインメニューの 「Webhooks」 に移動します
- 「New Webhook」 をクリックしてセットアップウィザードを起動します
ステップ 2: 基本情報
webhook に分かりやすい名前を付け、配信タイプを選択します:
- 名前 - 「速報テックニュース」や「マーケット更新」など、分かりやすいものを選びます
- 説明 - webhook の目的の任意の簡単な説明
- 配信タイプ - 記事をどのように配信するかを選択します:
- エンリッチ (既定) — 企業データ、感情、完全なフィルタリングオプションを含む AI 処理済みペイロード。エンリッチ Webhook ガイドを参照してください。
- Raw — より高速な配信、簡素化されたペイロード、限定的なフィルター。Raw Webhook ガイドを参照してください。
ステップ 3: ニュース条件を定義する
関連する記事だけを受け取れるようにフィルタリングを設定します。利用可能なオプションは選択した配信タイプによって異なります。
ご利用のタイプの完全なフィルターリファレンスについては、エンリッチ Webhook または Raw Webhook を参照してください。
ステップ 4: 宛先とセキュリティを設定する
Webhook の宛先
ニュースを送信するエンドポイント URL を指定します:
- 公開 HTTPS URL である必要があります
- すばやく応答する必要があります(5 秒未満)
セキュリティ設定
webhook エンドポイントの保護方法を選択します:
- なし - 追加の認証なし(本番環境には推奨されません)
- 基本認証 - HTTP Basic Auth によるユーザー名/パスワード保護
- カスタムヘッダー -
X-Finlight-Keyヘッダーで API キーを送信します - 署名検証 -
X-Webhook-Signatureヘッダーによるペイロード検証のため常に含まれます
注: 選択した認証方法に関係なく、ペイロードの整合性検証のため、署名検証はすべての webhook で自動的に有効になります。
これらのセキュリティオプションの実装について、認証ガイドで詳しく学べます。
統合をテストする
組み込みのテストツール
本番稼働の前に、webhook の設定を検証します:
- ダッシュボードのテスト機能 - エンドポイントにサンプルペイロードを送信します
- 配信モニタリング - 成功率と応答時間を追跡します
- エラー診断 - 失敗した配信をデバッグします
包括的なテスト手順、ペイロード例、トラブルシューティングのヒントについては、webhook テストガイドを参照してください。
お困りですか?
クイックサポートの選択肢
ペイロードとフィルタリング
ご利用のタイプの記事モデルとフィルターリファレンスについては、エンリッチ Webhook または Raw Webhook を参照してください。
技術的なセットアップ
詳しい実装サポートについては、認証ガイドとテストガイドを参照してください。
一般的なサポート
追加のリソースとお問い合わせ先については、サポートページをご覧ください。
ダッシュボードに関する問題
app.finlight.me で webhook 管理にアクセスするか、プラットフォームからサポートにお問い合わせください。
始める準備はできましたか?
Webhook は、ニュース更新の受け取り方を一変させます。数分ごとのポーリングから、ニュースが発生した瞬間の即時配信へ。
基本的なフィルタリング条件でシンプルに始め、アプリケーションに最適なものを見つけながら徐々に拡張しましょう。finlight ダッシュボードを使えば、webhook をいつでも簡単に変更・最適化できます。