通知設定

通知概覽#

通知目標#

Slack#

將 Apidog 通知與 Slack 整合#

步驟 1：開啟頻道詳細資訊

在 Slack 頻道中，點選右上角的「Open channel details」選項。

步驟 2：安裝 Incoming WebHook

在特定 Channel 的 Integrations - Apps 中，安裝並新增 Incoming WebHook。

步驟 3：檢視 Incoming WebHooks

安裝完成後，點選 Incoming WebHooks 右側的 View 按鈕。

步驟 4：設定 Incoming WebHooks

這會開啟 Incoming WebHooks 的說明頁面，點選 Configuration 進行設定。

步驟 5：新增到 Slack

點選 Add to Slack。

步驟 6：選擇 Channel 並新增整合

選擇要推送 Apidog 通知事件訊息的 Channel，然後點選 Add Incoming WebHooks integration。

步驟 7：取得 Webhook URL

取得並複製 Webhook URL。

步驟 8：在 Apidog 中建立通知目標

點選「Settings」>「Notifications」>「Notification Targets」>，並建立新的通知 Target。

填寫通知目標名稱。

選擇 Slack 作為通知渠道。

將從 Incoming WebHooks 設定中取得的 Webhook URL 貼到 Service URL。

Teams#

將 Apidog 通知與 Teams 頻道整合#

步驟 1：在 Teams 中建立 workflow

在 Microsoft Teams → Workflow 中，點選 Create，並可透過選擇範本 Post to a channel when a webhook request is received 快速開始。

步驟 2：設定流程名稱與帳戶

為流程設定名稱，選擇適當的帳戶，然後點選 Next。

步驟 3：選擇群組與頻道

選擇要接收通知的群組與頻道，然後點選 Create flow。

步驟 4：取得 HTTP POST URL

流程建立後，觸發步驟下方會顯示 HTTP POST URL。你可以直接複製，或稍後在流程的觸發步驟中找到它。

步驟 5：在 Apidog 中設定通知目標

將此 HTTP POST URL 貼到 Apidog 的通知目標設定中。

步驟 6：建立通知事件

在 Apidog 中建立通知事件，並將其與已設定的 Teams 通知目標關聯。

步驟 7：驗證 Teams 通知

當此通知事件被觸發時，先前建立的 workflow 會自動將訊息發布到所選的 Teams 頻道。

Webhook#

將 Apidog 通知與自架 HTTP Server 整合#

Jenkins#

將 Apidog 通知與 Jenkins 服務整合#

步驟 1：在 Jenkins Generic Webhook Trigger 外掛程式中設定 Webhook URL

在 Jenkins Dashboard 上建立新的檢視：

點選上一步中的檢視以進入 Configure>Build Triggers，並選擇 Generic Webhook Trigger。Webhook URL 為 "http://"+"your service address"+"/generic-webhook-trigger/invoke"

支援自訂 token：

步驟 2：建立新的通知目標

點選「Settings」>「Notifications」>「Notification Targets」>，並建立新的通知 Target。

填寫通知目標名稱。

選擇 Jenkins 作為渠道

在 Service URL 欄位中貼上 Generic Webhook Trigger 外掛程式中設定的 Webhook URL

如果使用自訂 token，請將 Token 複製並貼到 Signature Token 欄位。

Email#

將 Apidog 通知與 Email 整合#

通知事件#

觸發事件#

通知目標#