개요
GET /jobs/{id}를 반복해서 폴링하는 대신, 작업이 완료될 때 POST 요청을 받을 웹훅 URL을 제공할 수 있습니다. 이는 더 효율적이며 불필요한 API 호출을 줄여줍니다.
웹훅 사용하기
어떤 생성 요청에든X-Webhook-URL 헤더를 추가하세요. 작업이 종료 상태(completed, failed, cancelled)에 도달하면 API가 제공한 URL로 전체 작업 데이터를 담아 POST 요청을 보냅니다.
웹훅 페이로드
작업이 완료되면 웹훅 URL은 다음과 같은 작업 데이터가 담긴 POST 요청을 받습니다:모범 사례
빠르게 응답하세요 - 2xx 상태 코드를 신속하게 반환하세요. 필요하다면 웹훅 데이터는 비동기로 처리하세요.
- 보안을 위해 HTTPS 엔드포인트를 사용하세요
- 중복 전달에 대비해 멱등성을 구현하세요
- 디버깅을 위해 웹훅 수신 로그를 남기세요
웹훅 대 폴링
HTTP 요청을 받을 수 있는 서버가 있다면 웹훅을 사용하세요. 클라이언트 측 애플리케이션이거나 공개 엔드포인트를 노출할 수 없다면 폴링을 사용하세요.
다음 단계
Job Lifecycle
작업 상태와 상태 폴링에 대해 알아보기
Code Examples
웹훅 처리가 포함된 전체 예제 보기