웹훅 | BeatAPI API Documentation

BeatAPI 작업 완료 알림(선택 사항)을 받을 웹훅 엔드포인트를 만듭니다.

생성 시 반환된 서명 비밀 값을 저장하고, 모든 콜백을 원시 요청 본문으로 검증하며, 대체 기준 정보로 폴링을 계속하세요. 운영 환경의 재시도 동작은 빠른 시작을 참고하세요.

AuthorizationBearer

API 키를 Authorization: Bearer <BEATAPI_API_KEY>로 보내세요.

This endpoint expects an object.

urlstring필수형식: "uri"

BeatAPI 작업 이벤트를 받는 공개 HTTPS 콜백 URL입니다. localhost나 사설 네트워크 URL은 사용하지 마세요.

descriptionstring선택 사항

계정에서 엔드포인트를 구분하기 위한 내부 라벨입니다(선택 사항).

eventslist of enums선택 사항

전달할 작업 이벤트입니다. 생략하면 task.succeeded와 task.failed를 모두 구독합니다.

허용된 값:

웹훅 엔드포인트 생성됨

dataobject

생성되었거나 조회된 웹훅 엔드포인트입니다. 공개 API 응답은 생성 시 전체 서명 비밀 값을 반환하고 이후에는 가리며, 인증된 Dashboard 소유자는 명시적으로 다시 볼 수 있습니다.

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

500

Internal Server Error