Cập nhật 31/03/ 2022
Webhooks cho phép bạn tích hợp Zoho Mail với các ứng dụng bên ngoài khác. Webhook được sử dụng để kích hoạt một hành động trong một ứng dụng bằng cách sử dụng các sự kiện thời gian thực từ một ứng dụng bên ngoài. Webhook có hai loại - Webhook đến (Incoming webhooks) và Webhook đi (Outgoing webhooks). Các webhook đến được sử dụng để kích hoạt một hành động bên trong Zoho Mail bằng cách sử dụng các sự kiện thời gian thực từ các ứng dụng của bên thứ ba. Với các webhook gửi đi, các email đến của bạn có thể được định cấu hình để kích hoạt các hành động trong các ứng dụng bên ngoài.
Để thiết lập tích hợp giữa Zoho Mail và bất kỳ ứng dụng bên thứ ba nào, bạn sẽ phải định cấu hình một webhook đến trong một ứng dụng và một webhook gửi đi trong ứng dụng kia. Ví dụ: nếu bạn muốn đăng sự kiện từ ứng dụng bên ngoài lên nhóm Stream của mình, thì các bước sau phải được thực hiện.
1. Định cấu hình một webhook đến trong Zoho Mail.
2. Lấy URL Webhook được tạo trong khi tạo webhook đến.
3. Định cấu hình một webhook gửi đi trong ứng dụng của bên thứ ba bằng cách sử dụng URL webhook có được.
Nếu bạn muốn kích hoạt sự kiện trong ứng dụng bên ngoài khi nhận được email, bạn cần định cấu hình webhook gửi đi trong Zoho Mail và webhook đến trong ứng dụng của bên thứ ba.
Webhook đến cho phép bạn đăng lên URL bạn chọn khi một sự kiện cụ thể xảy ra trong ứng dụng của bên thứ ba. Bạn có thể định cấu hình webhook đến để đăng tin nhắn, ghi chú hoặc tác vụ trong nhóm Stream của mình bằng cách sử dụng thông tin nhận được từ ứng dụng bên ngoài.
1. Đăng nhập vào Zoho Mail
2. Điều hướng đến Cài đặt >> Tích hợp >> Không gian dành cho nhà phát triển
3. Chọn Đến trong phần Webhooks ở menu bên trái.
4. Nhấp vào Thêm cấu hình mới
(Hình incomingweb1)
5. Chọn định dạng bài đăng
(Hình incomingweb2)
- Thư - Webhook cập nhật sẽ được gửi đến hộp thư đến của bạn dưới dạng email.
- Đăng /Ghi chú /Nhiệm vụ - Webhook cập nhật sẽ được đăng trong nhóm Stream ưu tiên dưới dạng bài đăng /ghi chú /nhiệm vụ
6. Nếu bạn đã chọn Thư ở bước trước, hãy bỏ qua bước này. Nếu bạn đã chọn bài đăng /ghi chú /nhiệm vụ, hãy nhập các chi tiết sau vào trang cấu hình:
(Hình incomingweb3)
- Tên người dùng tùy chỉnh - Tên này sẽ được sử dụng để đăng trong Stream
- Nhóm - Nhóm nơi các bản cập nhật sẽ được đăng
7. Sau đó, nhấp vào Chức năng Viết bên dưới Chức năng tùy chỉnh nếu bạn muốn sửa đổi dữ liệu trong yêu cầu bài đăng cho phù hợp với định dạng webhook theo nhu cầu của bạn. Sau khi bạn tạo chức năng tùy chỉnh, hãy nhấp vào Chọn chức năng tùy chỉnh để chọn chức năng.
(Hình incomingweb4)
8. Nhấp vào Tạo URL và sao chép URL đã tạo
(Hình incomingweb5)
URL đã được tạo được sử dụng trong khi định cấu hình một webhook gửi đi trong ứng dụng của bên thứ ba mà bạn chọn.
Ghi chú:
Webhook đến chỉ có thể được định cấu hình cho nhóm Stream bởi người kiểm duyệt hoặc chủ sở hữu của nhóm.
Nếu bạn muốn bài đăng Stream bao gồm @nhắc đến, hãy đưa nội dung sau vào nội dung thư:
- Để @nhắc đến một thành viên trong nhóm, hãy bao gồm @emailID trong tin nhắn. Ví dụ: Tới @mention Rebecca, @rebecca @zylker.com
- Để @nhắc đến một nhóm, hãy bao gồm @group trong tin nhắn. Nhóm được định cấu hình cho webhook sẽ tự động được gắn thẻ.
URL webhook không được tiết lộ cho những người không có thẩm quyền. Nếu bị lộ, họ sẽ có thể đăng nội dung cập nhật lên nhóm Stream của bạn.
Nếu bạn tạo lại URL webhook, bạn sẽ cần phải thay thế URL cũ bằng URL mới ở tất cả những nơi nó đã được sử dụng.
Webhook gửi đi cho phép bạn định cấu hình email của mình để kích hoạt các sự kiện trong các ứng dụng của bên thứ ba. Bạn có thể đăng chi tiết email bạn nhận được lên các ứng dụng bên ngoài. Các tùy chọn bộ lọc trong cấu hình cho phép bạn chọn những email mà bạn muốn đóng vai trò là trình kích hoạt cho sự kiện.
1. Đăng nhập vào Zoho Mail
2. Điều hướng đến Cài đặt >> Tích hợp >> Không gian dành cho nhà phát triển
3. Chọn Thư đi trong phần Webhooks ở menu bên trái.
4. Nhấp vào Thêm cấu hình mới
(Hình outgoingweb1)
5. Nhập các chi tiết sau vào trang cấu hình:
(Hình outgoingweb2)
- Tên người dùng tùy chỉnh - Tên được đặt cho cấu hình webhook
- URL webhook - URL thu được từ cấu hình webhook đến trong ứng dụng của bên thứ ba. Các cập nhật được kích hoạt từ Zoho Mail sẽ được đăng lên URL này.
- Loại điều kiện thư - Các email đáp ứng các tiêu chí này sẽ kích hoạt các sự kiện trong ứng dụng của bên thứ ba.
6. Nhấp vào Chức năng Viết bên dưới Chức năng tùy chỉnh nếu bạn muốn sửa đổi dữ liệu trong yêu cầu bài đăng cho phù hợp với định dạng webhook theo nhu cầu của bạn. Sau khi bạn tạo chức năng tùy chỉnh, hãy nhấp vào Chọn chức năng tùy chỉnh để chọn chức năng.
(Hình outgoingweb3)
7. Nhấn lưu
Ghi chú:
- Nếu URL webhook được sử dụng trong cấu hình không phản hồi trong một thời gian dài, webhook gửi đi sẽ tự động bị vô hiệu hóa.
- Khi bạn lưu cấu hình webhook gửi đi lần đầu tiên, một yêu cầu ĐĂNG sẽ được bắt đầu. Cấu hình sẽ chỉ được lưu nếu nhận được 200 phản hồi cho yêu cầu ĐĂNG.
WEBHOOK RESPONSE SAMPLE:
{
"summary": "Hi Rebecca, I have shared the slide deck for our product pitch meeting on Friday. Please take a look and do let me know if you have any suggestions. Regards, Paula",
"sentDateInGMT": 1560866021000,
"subject": "Marketing - Product pitch",
"messageId": 1560840837125110000,
"toAddress": "\"Rebecca A\"",@zylker.com>
"folderId": 3881227000000013000,
"zuid": 647772765,
"ccAddress": "",
"size": 55503,
"sender": "Paula",
"receivedTime": 1560840837126,
"fromAddress": "paula@zylker.com",
"html": "
"IntegIdList": "34000000580271,"
}
Bạn nên bảo mật webhook vì nó giúp bạn xác định xem các yêu cầu có thực sự bắt nguồn từ Zoho Mail hay không. Để cho phép bạn xác minh các webhook, Zoho Mail thêm chữ ký vào tất cả các yêu cầu webhook của nó. Điều này bổ sung thêm một lớp bảo mật cho webhook của bạn.
Xác thực các yêu cầu Webhook
Mỗi yêu cầu webhook chứa một chữ ký cho mục đích xác minh. Chìa khóa được sử dụng để ký thông báo là bí mật x-hook-secret. Bí mật này chỉ có được từ tiêu đề của yêu cầu đầu tiên của webhook. Chữ ký x-hook-signature được tìm thấy trong tiêu đề HTTP của tất cả các yêu cầu. Tiêu đề là bản thông báo cơ sở 64 của băm HMAC SHA256. Nội dung băm phải là đại diện nhị phân của toàn bộ phần nội dung yêu cầu.
Để xác minh chữ ký, bạn sẽ được yêu cầu tạo chữ ký của riêng mình bằng cách sử dụng x-hook-secret. Sau đó, bạn có thể so sánh chữ ký đã tạo với chữ ký trong tiêu đề yêu cầu để kiểm tra tính xác thực của yêu cầu.
Dưới đây là mã mẫu để kiểm tra tính hợp lệ của một yêu cầu:
JAVA:
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.servlet.http.HttpServletRequest;
//method to validate webhook request
boolean verifyWebhookRequest(String secret, String payload, HttpServletRequest request) throws Exception
{
Mac mac = Mac.getInstance("HmacSHA2256");
SecretKeySpec secretKey = new SecretKeySpec(secret.getBytes(), "HmacSHA256");
mac.init(secretKey);
String signature = Base64.encodeBase64String(mac.doFinal(payload.getBytes()));
return signature.equals(request.getHeader("X-Hook-Signature"));
}
JAVA SCRIPT:
function VerifyWebhookRequest(request, secret)
{
//secret is x-hook-secret while registering webhook to URL
var crypto = require('crypto');
var headerHash = request.headers['x-hook-signature'];
var createdHash = crypto.createHmac('sha256' , secret).update(request.body).digest('base64');
return headerHash = = = createdHash;
}
Vui lòng nhập các thông tin bên dưới để chúng tôi tư vấn tốt hơn cho quy khách!
Hoặc gọi ngay cho chúng tôi:
0919 050 560
