Tham chiếu · Tin cậy và xác minh

Payload webhook

Hình dạng sự kiện, header chữ ký, và chống phát lại.

Hình dạng sự kiện webhook, header chữ ký, và chống phát lại.

Xác minh trước, xử lý sau#

Endpoint webhook của bạn nhận POST từ bất kỳ ai tìm thấy URL của nó. Xác minh chữ ký trước khi đọc tới payload.

Header#

Header	Nội dung
`hideguard-signature`	Chữ ký của body
`hideguard-delivery`	ID duy nhất của lần gửi này
`hideguard-event`	Loại sự kiện

Chống phát lại#

hideguard-delivery là duy nhất cho mỗi lần gửi. Lưu lại các ID đã xử lý và bỏ qua ID trùng.

Một lần gửi thất bại sẽ được thử lại, nên endpoint của bạn phải idempotent dù có hay không có kẻ tấn công.

Trả về nhanh#

Trả 2xx ngay khi bạn đã lưu sự kiện, rồi xử lý sau. Một endpoint xử lý đồng bộ trong vài giây sẽ bị tính là timeout và nhận các lần thử lại mà nó không cần.

Mọi request tới URL do bạn khai đều đi qua kiểm tra địa chỉ, bên trong chính lần phân giải DNS của socket: không phải kiểm tra trước rồi kết nối sau. Một tên miền có thể trả lời khác nhau giữa hai lần tra, và 169.254.169.254 là endpoint metadata của các nhà cung cấp cloud.

Đăng ký và xem lần gửi#