이벤트
웹훅 연결하기
- Foliant에서 설정 › 연동으로 이동합니다.
- 웹훅에서 연결을 클릭합니다.
-
설정을 입력합니다.
- 연결을 클릭합니다.
각 요청의 내용
Foliant는 JSON 본문과 함께POST 요청을 보냅니다.
document.generated 데이터
template: 템플릿의uuid및name.document_type:invoice,credit_note,quote또는 기타 문서의 경우 빈 값.order: 주문의id,name및type(주문 또는 임시 주문).refund_id및fulfillment_id: 환불 또는 배송에 대한 문서인 경우.document_number및issued_at: 번호가 매겨진 문서인 경우.source: 생성 방식. 예:download,admin_download,export또는email.export: 내보내기에 포함된 경우 내보내기 ID.generated_at.
export.completed 데이터
export: 내보내기의uuid,order_type,template_uuids,orders수,orders_skipped(선택된 후 삭제된 주문) 및documents,requested_by(merchant또는customer),completed_at.download_url: 내보내기를 다운로드할 수 있는 링크,download_url_expires_at: 해당 링크가 만료되는 시점.download_expires_at: 내보내기 자체가 만료되는 시점.
헤더
서명 확인하기
서명은 타임스탬프, 마침표, 원본 요청 본문(<timestamp>.<body>)을 서명 시크릿을 키로 사용하여 계산한 16진수 HMAC-SHA256 값입니다. 수신 측에서 직접 계산한 후 X-Foliant-Signature의 sha256= 뒤에 있는 값과 비교하세요. 원본 본문은 수신한 그대로 사용하세요.
응답 및 재시도
- 2xx 응답은 모두 전송 완료로 간주됩니다.
- 엔드포인트가 5xx 오류, 408 또는 429를 반환하거나 10초 이내에 응답하지 않으면 Foliant는 나중에 다시 시도합니다. 시도할 때마다 대기 시간이 길어지며 최대 5회까지 시도합니다.
- 그 외 4xx 응답은 최종 결과로 처리되며 Foliant는 재시도하지 않습니다.
- 각 이벤트는 문서 또는 내보내기당 한 번 전송됩니다. 전송에 성공한 후에는 재시도로 인해 중복 전송되지 않습니다.