Tổng quan về thông báo#
Apidog cho phép bạn tích hợp với các ứng dụng bên thứ ba để gửi thông báo đến những người nhận được chỉ định khi một số sự kiện nhất định xảy ra. Khi một sự kiện cụ thể được kích hoạt, thông báo sẽ được gửi theo thời gian thực đến các nền tảng như Slack. Các kênh thông báo hiện được hỗ trợ bao gồm:Chỉ quản trị viên dự án mới có thể cấu hình cài đặt thông báo. Hiện tại, thông báo qua email chỉ khả dụng cho các sự kiện sau:Kiểm thử tự động đã hoàn tất/thất bại
Tích hợp liên tục đã hoàn tất/thất bại
Tác vụ theo lịch đã hoàn tất/thất bại
Mục tiêu thông báo#
Mục tiêu thông báo là những người nhận nhận được thông điệp thông qua một kênh cụ thể khi một số sự kiện nhất định xảy ra.Để thiết lập thông báo, trước tiên bạn cần tạo một mục tiêu thông báo bằng cách chỉ định tên, chọn kênh và cấu hình các cài đặt của kênh đó. Mỗi kênh có một quy trình thiết lập riêng. Các phần bên dưới sẽ hướng dẫn bạn cấu hình từng bước.Slack#
Apidog hỗ trợ gửi sự kiện thông báo đến một Channel cụ thể trong Slack bằng cách tích hợp ứng dụng Slack - Incoming WebHooks trong Channel được chỉ định và cấu hình Webhook URL của Incoming WebHooks, qua đó có thể gửi thông điệp sự kiện đến Slack Channel.| Trường cấu hình | Bắt buộc | Mô tả |
|---|
| Tên thông báo | Không | Đặt tên cho thông báo tích hợp bên thứ ba để ghi nhận mục đích của thông báo đó. |
| Sự kiện kích hoạt | Có | Các sự kiện được hỗ trợ: thay đổi API, thay đổi schema, thay đổi tài liệu, nhập dữ liệu, kiểm thử tự động |
| Service URL | Có | Webhook URL trong "Incoming WebHooks - Integration Settings" |
Tích hợp thông báo Apidog với Slack#
Quản trị viên dự án có thể sử dụng các chức năng tích hợp bên thứ ba để liên kết ứng dụng Slack - Incoming WebHooks được thêm trong Slack - Channels với các sự kiện thông báo của dự án trong Apidog nhằm đẩy các thay đổi API liên quan, thay đổi tài liệu, hoàn tất kiểm thử, v.v. đến Channel được chỉ định trong Slack.Bước 1: Mở thông tin chi tiết của channel
Trong Slack channel, nhấp vào tùy chọn "Open channel details" ở góc trên bên phải.Bước 2: Cài đặt Incoming WebHook
Trong Integrations - Apps của Channel cụ thể, cài đặt và thêm Incoming WebHook.Bước 3: Xem Incoming WebHooks
Sau khi cài đặt hoàn tất, nhấp vào nút ở bên phải của Incoming WebHooks - View.Bước 4: Cấu hình Incoming WebHooks
Thao tác này sẽ mở trang mô tả của Incoming WebHooks; nhấp vào Configuration để thiết lập.Bước 5: Thêm vào Slack
Bước 6: Chọn Channel và thêm tích hợp
Chọn Channel để đẩy thông điệp sự kiện thông báo của Apidog đến, sau đó nhấp vào Add Incoming WebHooks integration.Bước 7: Lấy Webhook URL
Lấy và sao chép Webhook URL.Bước 8: Tạo mục tiêu thông báo trong Apidog
Nhấp vào "Settings" > "Notifications" > "Notification Targets" > và tạo một notification Target mới.Điền tên mục tiêu thông báo.
Chọn Slack làm kênh thông báo.
Dán Webhook URL lấy được từ cài đặt Incoming WebHooks vào Service URL.
Teams#
Hỗ trợ gửi thông báo đến Microsoft Teams cho phép Workflows trong Teams sử dụng các thông điệp này làm trình kích hoạt cho các hành động tiếp theo—chẳng hạn như tự động đăng thông điệp trong một nhóm hoặc channel—giúp các nhóm nắm bắt các sự kiện quan trọng từ Apidog.Cụ thể, bạn có thể cấu hình một Webhook Trigger trong một Workflow. Khi các sự kiện thông báo nhất định trong Apidog được kích hoạt (ví dụ: thay đổi API, cập nhật tài liệu hoặc hoàn tất kiểm thử tự động), Apidog sẽ gửi một yêu cầu POST đến HTTP POST URL được chỉ định của trình kích hoạt, kèm theo payload sự kiện.| Trường | Bắt buộc | Mô tả |
|---|
| Name | Có | Tên mô tả mục đích của mục tiêu thông báo này |
| HTTP POST URL | Có | URL nơi Webhook Trigger trong Workflow nhận các yêu cầu POST |
Tích hợp thông báo Apidog với Teams Channels#
Bước 1: Tạo workflow trong Teams
Trong Microsoft Teams → Workflow, nhấp vào Create, và bạn có thể bắt đầu nhanh bằng cách chọn mẫu Post to a channel when a webhook request is received.Bước 2: Đặt tên flow và tài khoản
Đặt tên cho flow, chọn tài khoản phù hợp và nhấp vào Next.Bước 3: Chọn nhóm và channel
Chọn nhóm và channel nơi bạn muốn nhận thông báo, sau đó nhấp vào Create flow.Bước 4: Lấy HTTP POST URL
Sau khi flow được tạo, HTTP POST URL trong bước kích hoạt sẽ được hiển thị. Bạn có thể sao chép trực tiếp hoặc tìm lại sau trong bước kích hoạt của flow.Bước 5: Cấu hình mục tiêu thông báo trong Apidog
Dán HTTP POST URL này vào cấu hình mục tiêu thông báo trong Apidog.Bước 6: Tạo sự kiện thông báo
Tạo một sự kiện thông báo trong Apidog và liên kết sự kiện đó với mục tiêu thông báo Teams đã cấu hình.Bước 7: Xác minh thông báo Teams
Khi sự kiện thông báo này được kích hoạt, workflow đã tạo trước đó sẽ tự động đăng một thông điệp lên Teams channel đã chọn.Webhook#
Hỗ trợ gửi sự kiện thông báo đến HTTP Server. Bạn có thể gửi thông điệp sự kiện đến HTTP Server bằng cách chỉ định một địa chỉ URL để nhận các yêu cầu POST.| Trường cấu hình | Bắt buộc | Mô tả |
|---|
| Tên thông báo | Không | Đặt tên cho thông báo tích hợp bên thứ ba để ghi nhận mục đích của thông báo. |
| Sự kiện kích hoạt | Có | Các sự kiện được hỗ trợ: thay đổi API, thay đổi mô hình dữ liệu, thay đổi tài liệu, nhập dữ liệu, kiểm thử tự động |
| Server URL | Có | Địa chỉ URL của HTTP Server để nhận yêu cầu |
| Signature Auth | Không | Nội dung được gửi được mã hóa bằng thuật toán mã hóa HMAC SHA1, sử dụng token làm KEY để hiển thị giá trị ở dạng thập lục phân (yêu cầu token đã được cấu hình), và chứa tiền tố sha1= |
Tích hợp thông báo Apidog với HTTP Server tự lưu trữ#
Quản trị viên dự án có thể sử dụng tích hợp bên thứ ba để liên kết HTTP Server tự lưu trữ của họ với các sự kiện thông báo của dự án trong Apidog, nhằm nhận thông báo về các thay đổi API liên quan, thay đổi tài liệu và hoàn tất kiểm thử tự động trong HTTP Server của họ.Để tích hợp thông báo Apidog với HTTP server tự lưu trữ, nhấp vào "Settings" > "Notifications" > "Notification Targets" > và tạo một notification Target mới.1.
Điền tên mục tiêu thông báo.
3.
Dán URL của HTTP Server tự lưu trữ vào trường Service URL.
4.
Nếu xác minh chữ ký được bật, hãy sao chép và dán khóa vào trường Signature Key.
Jenkins#
Hỗ trợ gửi sự kiện thông báo đến dịch vụ Jenkins. Bằng cách cấu hình Jenkins Webhook URL, thông điệp sự kiện có thể được gửi đến Jenkins.| Trường cấu hình | Bắt buộc | Mô tả |
|---|
| Tên thông báo | Không | Đặt tên cho thông báo tích hợp bên thứ ba để ghi nhận mục đích của thông báo đó. |
| Sự kiện kích hoạt | Có | Thay đổi API, thay đổi mô hình dữ liệu, nhập dữ liệu, kiểm thử tự động. Thông báo thời gian thực sẽ được kích hoạt khi bất kỳ sự kiện nào ở trên xảy ra. |
| Service URL | Có | URL được cấu hình trong plugin Generic Webhook Trigger. |
| Signature Auth | Không | Được gửi đến plugin Generic Webhook Trigger thông qua header Authorization Bearer. |
Tích hợp thông báo Apidog với dịch vụ Jenkins#
Quản trị viên dự án có thể sử dụng chức năng tích hợp bên thứ ba để liên kết Webhook URL được cấu hình trong plugin Jenkins Generic Webhook Trigger với các sự kiện thông báo của dự án trong Apidog, nhằm tự động kích hoạt hành động build trong Jenkins khi các sự kiện như thay đổi API, thay đổi tài liệu và hoàn tất kiểm thử tự động được kích hoạt, đồng thời xem thông điệp trong lịch sử build.Bước 1: Webhook URL được cấu hình trong plugin Jenkins Generic Webhook Trigger
Tạo một view mới trên Jenkins Dashboard:Nhấp vào view ở bước trước để vào Configure>Build Triggers, và chọn Generic Webhook Trigger. Webhook URL là "http://"+"your service address"+"/generic-webhook-trigger/invoke"Token tùy chỉnh được hỗ trợ:Bước 2: Tạo một mục tiêu thông báo mới
Nhấp vào "Settings" > "Notifications" > "Notification Targets" > và tạo một notification Target mới.Điền tên mục tiêu thông báo.
Nếu sử dụng token tùy chỉnh, hãy sao chép và dán Token vào trường Signature Token.
Email#
Thông báo có thể được gửi qua email đến các địa chỉ email được chỉ định. Hiện tại, thông báo qua email chỉ khả dụng cho các sự kiện sau:Kiểm thử tự động đã hoàn tất/thất bại
Tích hợp liên tục đã hoàn tất/thất bại
Tác vụ theo lịch đã hoàn tất/thất bại
| Trường | Bắt buộc | Chi tiết |
|---|
| Name | Có | Tên mô tả làm nổi bật mục đích hoặc đặc điểm của mục tiêu thông báo. |
| Notification Email Address | Có | Nhập (các) địa chỉ email để nhận thông báo. Bạn có thể chọn địa chỉ email của thành viên dự án hoặc nhập thủ công một địa chỉ. Hỗ trợ nhiều địa chỉ email. |
Tích hợp thông báo Apidog với Email#
1.
Điền tên mục tiêu thông báo.
Sự kiện thông báo#
Bạn có thể tạo sự kiện thông báo để chỉ định sự kiện nào sẽ kích hoạt thông báo đến người nhận được chỉ định (mục tiêu thông báo). Để thiết lập một sự kiện thông báo, bạn cần cấu hình:Sự kiện kích hoạt#
Bạn có thể chọn từ các sự kiện thông báo sau để kích hoạt thông báo:| Sự kiện kích hoạt | Chi tiết |
|---|
| Endpoint Changed | Endpoint Created
Endpoint Updated
Endpoint Deleted |
| Schema Changed | Schema Created
Schema Updated
Schema Deleted |
| Document Changed | Document Created
Document Updated
Document Deleted |
| Data Import | Import (Manual Import)
Import (Auto Sync) |
| Response Component Changed | Response Component Created
Response Component Updated
Response Component Deleted |
| Sprint Branch Changed | Sprint Branch Merged
Sprint Branch Created
Sprint Branch Archived
Sprint Branch Deleted
Sprint Branch Retrieved |
| API Version Changed | API Version Created
API Version Deleted |
| Security Scheme Changed | Security Scheme Created
Security Scheme Updated
Security Scheme Deleted |
Đối với các thông báo liên quan đến kiểm thử tự động (ví dụ: kiểm thử tự động đã hoàn tất, tích hợp liên tục đã hoàn tất, tác vụ theo lịch đã hoàn tất), bạn cần cấu hình cài đặt riêng cho từng kịch bản kiểm thử. Cách tiếp cận này linh hoạt hơn và phù hợp hơn với các trường hợp sử dụng thực tế.
Mục tiêu thông báo#
Chọn các mục tiêu thông báo sẽ nhận thông báo khi một sự kiện kích hoạt xảy ra. Bạn có thể chọn từ các mục tiêu thông báo đã được thiết lập trong dự án và chọn nhiều mục tiêu nếu cần.Tuy nhiên, thông báo qua email chỉ được hỗ trợ cho ba sự kiện cụ thể:Kiểm thử tự động đã hoàn tất/thất bại
Tích hợp liên tục đã hoàn tất/thất bại
Tác vụ theo lịch đã hoàn tất/thất bại
