Cấu hình webhook
Trỏ Timemark đến endpoint của bạn, chọn những sự kiện và dự án nào sẽ kích hoạt nó, và kiểm tra việc gửi dữ liệu.
Khi nào bạn cần làm việc này
Phần tiêu đề “Khi nào bạn cần làm việc này”Bạn muốn hệ thống của riêng bạn phản ứng khi có điều gì đó xảy ra trong Teamspace, ví dụ để ghi log việc tải ảnh lên hoặc kích hoạt một tác vụ xử lý tiếp theo. Webhook giúp Timemark gửi một yêu cầu POST đến endpoint của bạn mỗi khi một sự kiện đã chọn xảy ra.
Bạn cần gì
Phần tiêu đề “Bạn cần gì”- Vai trò
- Chủ đội nhóm
- Nền tảng
- Web
- Gói
- Business
- Ảnh hưởng đến
- Chỉ kích hoạt cho các sự kiện xảy ra sau khi webhook được tạo
Thiết lập webhook
Phần tiêu đề “Thiết lập webhook”- Vào Teamspace → Cài đặt → Tích hợp → Webhook.
- Nhập endpoint URL của bạn. URL này phải có thể truy cập công khai và phản hồi được yêu cầu POST.
- Xác nhận tác nhân kích hoạt. Webhook sẽ kích hoạt khi có Ảnh mới được tải lên.
- Chọn phạm vi: Tất cả ảnh, hoặc một thư mục cụ thể.
- Lưu.
Kiểm tra gửi dữ liệu
Phần tiêu đề “Kiểm tra gửi dữ liệu”- Trên webhook bạn vừa lưu, dùng chức năng kiểm tra hoặc ping để gửi một payload mẫu.
- Kiểm tra log endpoint của bạn để xác nhận payload đã đến.
- Xác nhận endpoint của bạn đã trả về phản hồi
2xx.
Các trường có thể cấu hình
Phần tiêu đề “Các trường có thể cấu hình”| Field | What it does | Notes |
|---|---|---|
| Endpoint URL | Nơi Timemark gửi yêu cầu POST | Phải công khai và trả về 2xx trong thời gian timeout |
| Tác nhân kích hoạt | Hành động kích hoạt việc gửi dữ liệu | Ảnh mới (photo.uploaded) hiện là tác nhân kích hoạt duy nhất. Xem Các loại sự kiện webhook |
| Phạm vi | Giới hạn việc kích hoạt trong một thư mục, hoặc tất cả ảnh của đội nhóm | Phạm vi thư mục chỉ kích hoạt cho ảnh trong thư mục đó |
Những lỗi thường gặp
Phần tiêu đề “Những lỗi thường gặp”- Không kích hoạt hồi tố. Webhook chỉ kích hoạt cho các sự kiện xảy ra sau khi nó được tạo. Ảnh đã có từ trước sẽ không kích hoạt nó.
- Endpoint phải trả về
2xxđúng thời hạn. Timeout hoặc lỗi sẽ được xem là gửi thất bại. Timemark sẽ thử gửi lại các lần gửi thất bại, sau đó dừng lại khi hết số lần thử lại. - Phạm vi không khớp. Webhook được giới hạn trong một thư mục sẽ không kích hoạt cho ảnh trong các thư mục khác. Đặt phạm vi thành Tất cả ảnh nếu bạn cần áp dụng cho mọi thư mục.
- Đứng sau tường lửa. Endpoint đứng sau VPN hoặc tường lửa sẽ không thể truy cập được. Hãy sử dụng một URL công khai.
Xem thêm
Phần tiêu đề “Xem thêm”Cập nhật lần cuối: