Webhook

리포트를 Webhook방식으로 수신합니다.

Webhook 방식이란? 서버(OMNI API)에서 클라이언트(사용자)가 지정한 URL로 변경 사항을 전달하는 방식입니다.

  • 리포트를 수신 받을 URL을 영업담당자에게 접수 해야 합니다.

  • 리포트 1개 당 1회 요청으로 전달됩니다.

  • 리포트 정보를 수신하면 규격에 맞는 응답(Response)을 주어야 합니다. 규격과 맞지 않거나 응답이 없을 경우 실패로 간주합니다.

  • Timeout은 5초로 설정되어 있습니다.(Connect Timeout, Read Timeout)

방화벽을 사용할 경우 아래의 Webhook 서비스 IP들을 허용 해야 합니다.

스테이징(STG): 211.115.98.198
운영(PRD): 211.115.98.154, 211.115.98.155, 211.115.98.205

1일 기준 실패 횟수(1,000회)가 초과되면 해당 계정은 리포트 전달이 차단됩니다.

REPORT WEBHOOK

POST 계정에 등록된 사용자 URL

리포트 데이터를 Webhook 방식으로 사용자URL에 전달합니다.

Headers

NameTypeDescription

Accept*

String

application/json

Content-Type*

String

application/json

Request Body

NameTypeDescription

msgKey*

String

메시지 키

reportCode*

String

reportType*

String

msgType

String

serviceType*

String

carrier

String

reportTime*

String

리포트 일시(ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SSS)

ref

String

참조필드

sendTime

String

전송 처리 일시(ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SSS)

reportText

String

리포트 상세

{
    "msgKey":"전달 받은 메시지키"
}

Last updated