Webhooks

ATRACE Report API의 report.completed 이벤트 알림.

리포트 처리는 비동기입니다. webhook은 "다시 조회할 시점"을 알려 주는 가벼운 포인터입니다. 객관 결과와 표시 콘텐츠의 신뢰 가능한 기준은 각각 인증된 GET /reports/{id}GET /reports/{id}/content입니다.

webhook 요청에 대한 서명 검증(HMAC 등)은 이번 릴리스에서 제공하지 않으며, 향후 제공 예정입니다.

등록

  • POST /reportscallback_url로 리포트별 수신 URL을 지정하거나,
  • API 클라이언트에 등록된 기본 callback_url을 사용합니다.

이벤트

report.completed

템플릿의 성공 개수 조건을 충족해 리포트가 준비되면 전송됩니다. 분석이 끝나면 리포트가 자동으로 공개되고 생성 시 이미 받은 공유 링크가 열람 가능해집니다.

{
  "event": "report.completed",
  "report_id": "123e4567-e89b-42d3-a456-426614174000",
  "external_inspection_id": "partner-INSP-0001",
  "occurred_at": "2026-06-24T03:02:10Z"
}

webhook 수신 뒤 GET으로 확인

webhook은 결과 요약이나 공유 URL을 포함하지 않습니다. report_idGET /reports/{id}를 호출해 report.v1 응답과 analysis_revision을 읽고, 이어서 links.content를 호출해 report-content.v1을 가져옵니다. external_inspection_id는 생성 요청에 값이 있었을 때만 포함됩니다.

자체 렌더링의 분석 완료는 analysis_status == "complete", ATRACE 공유 화면의 열람 가능 상태는 publication_status == "published"입니다. 활성 공유 링크는 report 응답의 links.share에만 나타납니다. share_url은 생성 응답부터 미리 제공될 수 있으므로 완료 판단 기준이 아닙니다.

콘텐츠가 아직 생성 중이면 /content202Retry-After를 반환합니다. 그 시간 뒤 다시 조회하세요. 준비된 콘텐츠는 ETag를 저장해 조건부 조회할 수 있습니다. 요청이 429/5xx로 실패하면 지수 백오프로 재시도하세요.

다음 단계

On this page