Skip to main content
GET
/
api
/
v1
/
webhook
/
test
Webhook 配信をテストする
curl --request GET \
  --url https://api.benzinga.com/api/v1/webhook/test \
  --header 'Key: <api-key>'
import requests

url = "https://api.benzinga.com/api/v1/webhook/test"

headers = {"Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Key: '<api-key>'}};

fetch('https://api.benzinga.com/api/v1/webhook/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.benzinga.com/api/v1/webhook/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.benzinga.com/api/v1/webhook/test"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.benzinga.com/api/v1/webhook/test")
.header("Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.benzinga.com/api/v1/webhook/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "status": "success"
}
{
  "error": "Invalid destination URL"
}
{
  "error": "Failed to deliver test payload to destination"
}
{
  "ok": false,
  "errors": [
    {
      "code": "auth_failed",
      "id": "unauthorized",
      "value": "Invalid or missing authentication token"
    }
  ]
}
{
  "ok": false,
  "errors": [
    {
      "code": "no_data_found",
      "id": "not_found",
      "value": "No data found for the specified parameters"
    }
  ]
}
{
  "ok": false,
  "errors": [
    {
      "code": "internal_server_error",
      "id": "server_error",
      "value": "An unexpected error occurred while processing your request"
    }
  ]
}

概要

このエンドポイントを使用すると、設定済みのエンドポイントにテスト用の webhook 配信を発生させることができます。これにより、本番環境のライブデータを受信する前に、webhook 連携が正しく動作していることを確認できます。

連携のテスト

このエンドポイントを呼び出すと、Benzinga は設定済みの destination URL にテスト用の webhook ペイロードを送信します。このテスト配信は、本番環境の webhook 配信と同じ形式および再試行ロジックで行われます。

想定される結果

  1. 即時レスポンス: テスト配信が正常にトリガーされると、API はステータスコード 200 を返します
  2. テストペイロード: Webhook エンドポイントには、本番データと同じ形式のテストペイロードが送信されます
  3. 配信ヘッダー: テスト配信には、本番配信と同様に X-BZ-Delivery ヘッダーが含まれます

統合を検証する

このエンドポイントを使用して、次の点を確認します:
  • Webhook エンドポイントがインターネットからアクセス可能であること
  • エンドポイントが Webhook ペイロード形式を正しくパースできること
  • エンドポイントが適切なステータスコード(成功時は 2xx)で応答すること
  • エンドポイントが 30 秒のタイムアウト以内に応答すること
  • 冪等性ロジックが X-BZ-Delivery ヘッダーとペイロードの id フィールドを正しく処理すること

ベストプラクティス

  • まずは本番環境ではない webhook エンドポイントでテストする
  • エンドポイントが 200 または 204 のステータスコードで応答することを確認する
  • ログおよび監視でテスト配信が記録されていることを確認する
  • 重複排除ロジックがテスト配信 ID で正しく動作することを確認する
  • 一時的にエラーのステータスコードを返してエラーシナリオをテストする

トラブルシューティング

424 配信エラー

424 ステータスコードを受け取った場合、システムがテストペイロードを宛先エンドポイントに配信できなかったことを意味します。よくある原因は次のとおりです。
  • 宛先URLが外部からアクセスできない
  • 宛先エンドポイントがエラーステータスコードを返している
  • ネットワーク接続の問題
  • 宛先エンドポイントでの SSL/TLS 証明書エラー

400 無効なリクエスト

必須パラメータがすべて指定されており、形式が正しいことを確認してください:
  • destination は有効な HTTPS URL である必要があります
  • versionwebhook/v1 である必要があります
  • kind はサポートされているイベント種別のいずれかである必要があります (例: News/v1, Earnings/v1, Ratings/v1 など)
{
  "status": "success"
}
{
  "error": "Invalid destination URL"
}
{
  "error": "Failed to deliver test payload to destination"
}
{
  "ok": false,
  "errors": [
    {
      "code": "auth_failed",
      "id": "unauthorized",
      "value": "Invalid or missing authentication token"
    }
  ]
}
{
  "ok": false,
  "errors": [
    {
      "code": "no_data_found",
      "id": "not_found",
      "value": "No data found for the specified parameters"
    }
  ]
}
{
  "ok": false,
  "errors": [
    {
      "code": "internal_server_error",
      "id": "server_error",
      "value": "An unexpected error occurred while processing your request"
    }
  ]
}

Authorizations

Key
string
header
required

Benzinga の API キー

Query Parameters

destination
string<uri>
required

テストデータの送信先となる webhook エンドポイントの url

version
enum<string>
default:webhook/v1
required

API バージョン。現在は webhook/v1。

Available options:
webhook/v1
kind
enum<string>
default:News/v1
required

テストペイロード内のメッセージ kind を識別します。

Available options:
News/v1,
Signals/v1,
Earnings/v1,
Ratings/v1,
Dividends/v1,
IPOs/v1,
Guidance/v1,
Splits/v1,
OptionActivity/v1,
Conference/v1,
Economics/v1,
Offerings/v1,
MA/v1,
Retail/v1,
FDA/v1,
WIIMs/v1,
SECInsiderTransaction/v1,
GovernmentTrade/v1
token
string

本番利用向けにデータを変換するためのトークンを指定します

Response

成功 - テスト Webhook を正常に送信しました

status
string
Example:

"success"