Tính ứng dụng nổi bật của việc sử dụng Webhook: 


1.Thông Báo Tự Động về Trạng Thái Đơn Hàng: Webhook cung cấp cập nhật tức thì khi có phát sinh các cập nhập về đơn hàng, giúp sellers luôn được thông báo mà không cần phải liên tục kiểm tra hoặc truy vấn dữ liệu. 

2. Tự Động Hóa Quy Trình Làm Việc: Tích hợp webhook cho phép tự động hóa các quy trình làm việc, chẳng hạn như cập nhật trạng thái đơn hàng, thông báo về giao dịch hoặc thay đổi vận chuyển, giảm thiểu công sức và thời gian cần thiết cho quản lý thủ công. 

3. Tùy Chỉnh Linh Hoạt: Sellers có thể chọn các sự kiện cụ thể mà bạn muốn nhận thông báo, cho phép tùy chỉnh linh hoạt phù hợp với nhu cầu cụ thể của doanh nghiệp.


Các bước thiết lập và sử dụng:


1. Lấy POST URL từ webhook service provider:

Chẳng hạn sử dụng Webhook.site


Copy phần URL


2. Webhook setting

Login vào tài khoản Merchize > Đến menu Settings > Chọn Webhook

Hệ thống hiển thị màn hình Webhook setting

a. Tạo secret key

Để nhận được webhook seller bắt buộc phải tạo merchize-webhook-key > Click nút Add secret Key

Hệ thống hiển thị như sau khi gen key thành công

b. Tạo webhook config

Click Add webhook: để tạo webhook > Tại popoup Add Webhook

  1. Enabled: Mặc định ở trạng thái nhận webhook Enabled

  2. Endpoint: Nhập link endpoint đã copy ở trên để nhận khi có sự kiện đến

  3. Events: Các sự kiện sẽ gửi webhook

Tên event

Mô tả

ORDER.CREATED

Khi có order được tạo mới

ORDER.PAYMENT.REFUND

Khi order có khoản refund

ORDER.CHANGED.TRACKING

Khi order có tracking hoặc được update tracking

ORDER.CHANGED.SHIPMENT

Khi có thay đổi về trạng thái shipment

ORDER.PAYMENT.TRANSACTION_FEE

Khi order phát sinh transaction fee (đối với order tạo từ storefront)

ORDER.PAYMENT.FULFILLMENT_COST

Khi order có khoản fulfillment cost đang pending

ORDER.PAYMENT.SURCHARGE

Khi order có khoản charge thêm

ORDER.CHANGED.PROGRESS

Khi có thay đổi package progress

ORDER.PAYMENT.FULFILLMENT_COST_PAID

Khi fulfillment cost ở trạng thái paid

ORDER.CHANGED.PROGRESS_STATUS

Khi có thay đổi order progress

c. Xem webhook config

Sau khi tạo webhook thành công > Thông tin hiển thị ở list Webhooks

  1. Cho phép bật/tắt gửi webhook

  2. Edit thông tin webhook config

  3. Xóa webhook



d. More action

Màn hình hiển thị 3 option

  • Webhook notification: Hiển thị tất cả các webhook

  • Webhook simulator: Gửi một webhook mẫu đến 1 endpoint nhận bất kỳ

  • Payload example: Mẫu webhook gửi sang




2. Webhook notification

2.1. Hỗ trợ tìm kiếm webhook

Webhook settings > More action > Webhook notification

  • Webhook URL: Tìm kiếm theo link endpoint đã config

  • Created at: Tìm kiếm theo ngày tạo webhook

  • Events: Tìm theo sự kiện

  • Status: Tìm kiếm theo trạng thái webhook

2.2. Hiển thị list webhook

  • Khi mới tạo webhook ở trạng thái "pending" > Click icon  để hủy không gửi webhook đi

  • Trường hợp gửi webhook thành công > Hiển thị trạng thái "done" > Click icon để xem thông tin webhook gửi đi

  • Trường hợp gửi webhook lỗi > Hiển thị trạng thái "failed" > Click icon để gửi lại webhook nếu webhook bị failed/cancelled




3. Webhook simulator

Webhook settings > More action > Webhook simulator

  1. Webhook URL: Nhập endpoint nhận webhook

  2. Events: Chọn event muốn gửi

  3. Click Send test để gửi webhook simulator



4. Payload example

Webhook settings > More action > Payload example

  1. Chọn event muốn xem thông tin

  2. Hệ thống trả về payload mẫu liên cho event đó