메인 콘텐츠로 건너뛰기
GET
/
api
/
v1
/
webhook
/
test
웹훅 전송 테스트
curl --request GET \
  --url https://api.benzinga.com/api/v1/webhook/test \
  --header 'Key: <api-key>'
{
  "status": "success"
}

​
개요

이 엔드포인트를 사용하여 구성해 둔 엔드포인트로 테스트 웹훅 전송을 실행할 수 있습니다. 이를 통해 실제 운영 데이터 수신 전에 웹훅 연동이 정상적으로 동작하는지 확인할 수 있습니다.

​
통합 테스트

이 엔드포인트를 호출하면 Benzinga에서 설정한 destination URL로 테스트용 webhook 페이로드를 전송합니다. 이 테스트 전송은 프로덕션 환경의 webhook 전송과 동일한 형식과 재시도 로직을 따릅니다.

​
예상되는 동작

  1. 즉시 응답: 테스트 전송이 성공적으로 트리거되면 API가 200 상태 코드를 반환합니다.
  2. 테스트 페이로드: 운영 환경 데이터와 동일한 형식의 테스트 페이로드가 웹훅 엔드포인트로 전송됩니다.
  3. 전송 헤더: 테스트 전송에도 운영 환경 전송과 동일하게 X-BZ-Delivery 헤더가 포함됩니다.

​
통합 검증

다음 사항을 확인하는 데 이 endpoint를 사용하십시오:
  • Webhook endpoint가 공용으로 액세스 가능한지
  • Endpoint가 webhook payload 형식을 올바르게 파싱할 수 있는지
  • Endpoint가 적절한 상태 코드(성공 시 2xx)로 응답하는지
  • Endpoint가 30초 타임아웃 내에 응답하는지
  • Idempotency 로직이 X-BZ-Delivery 헤더와 payload id 필드를 올바르게 처리하는지

​
모범 사례

  • 프로덕션 환경이 아닌 webhook 엔드포인트에서 먼저 테스트하세요
  • 엔드포인트가 200 또는 204 상태 코드를 반환하는지 확인하세요
  • 로그 및 모니터링에서 테스트 전송이 기록·수집되는지 확인하세요
  • 중복 제거 로직이 테스트 전송 ID와 함께 올바르게 동작하는지 확인하세요
  • 일시적으로 오류 상태 코드를 반환하도록 하여 오류 시나리오를 테스트하세요

​
문제 해결

​
424 전송 오류

424 상태 코드를 수신한 경우, 시스템이 테스트 페이로드를 대상 엔드포인트로 전달하지 못한 것입니다. 일반적인 원인은 다음과 같습니다:
  • 대상 URL이 공개적으로 액세스할 수 없음
  • 대상 엔드포인트가 오류 상태 코드를 반환함
  • 네트워크 연결 문제
  • 대상 엔드포인트의 SSL/TLS 인증서 오류

​
400 잘못된 요청

필수 매개변수가 모두 제공되었고 형식이 올바른지 확인하십시오.
  • destination은(는) 유효한 HTTPS URL이어야 합니다.
  • version은(는) webhook/v1이어야 합니다.
  • kind은(는) News/v1이어야 합니다.
{
  "status": "success"
}

인증

​
Key
string
header
필수

사용자의 Benzinga API 키

쿼리 매개변수

​
destination
string<uri>
필수

테스트 데이터를 수신할 webhook 엔드포인트 url

​
version
enum<string>
기본값:webhook/v1
필수

API 버전(현재는 webhook/v1)

사용 가능한 옵션:
webhook/v1
​
kind
enum<string>
기본값:News/v1
필수

메시지 kind를 식별합니다. 현재 값은 News/v1입니다.

사용 가능한 옵션:
News/v1
​
token
string

실서비스 환경에서 사용할 수 있도록 데이터를 변환하려면 토큰을 지정하세요

응답

성공 - 테스트 웹훅이 성공적으로 전송되었습니다

​
status
string
예시:

"success"