Webhook cho phép Gemini API gửi thông báo theo thời gian thực đến máy chủ của bạn khi các Thao tác không đồng bộ hoặc Thao tác chạy trong thời gian dài (LRO) hoàn tất. Điều này giúp bạn không cần phải thăm dò API để biết thông tin cập nhật về trạng thái, giảm độ trễ và chi phí.
Webhook có sẵn cho các thao tác như Công việc theo lô, Hoạt động tương tác và tạo video.
Cách hoạt động
Thay vì thăm dò GET /operations nhiều lần để kiểm tra xem một công việc đã hoàn tất hay chưa, bạn có thể định cấu hình Webhook Gemini API để gửi yêu cầu POST qua HTTP đến URL trình nghe ngay khi một sự kiện được kích hoạt.
Gemini API hỗ trợ 2 cách định cấu hình webhook:
- Webhook tĩnh: Điểm cuối ở cấp dự án được định cấu hình bằng Gemini WebhookService API. Phù hợp với các hoạt động tích hợp trên toàn cầu (ví dụ: thông báo cho Slack, đồng bộ hoá cơ sở dữ liệu, v.v.).
- Webhook động: Ghi đè ở cấp yêu cầu bằng cách truyền URL webhook trong tải trọng cấu hình của một lệnh gọi công việc cụ thể. Phù hợp để định tuyến các công việc cụ thể đến các điểm cuối chuyên dụng.
Webhook tĩnh
Webhook tĩnh được đăng ký cho toàn bộ dự án và kích hoạt cho mọi sự kiện phù hợp.
Tạo webhook
Bạn có thể tạo điểm cuối bằng SDK hoặc REST API.
QUAN TRỌNG: Khi tạo webhook, API sẽ chỉ trả về một lầnbí mật ký. Bạn phải lưu trữ bí mật này một cách an toàn (ví dụ: trong các biến môi trường) để xác minh chữ ký sau này. Nếu mất bí mật ký, bạn sẽ phải xoay vòng bí mật đó.