DOCS

Webhook

透過 Webhook 聆聽事件

取得 Zonos 整合的即時事件通知。

Webhook 是 Zonos 主動通知您的外部系統的一種方式,當發生特定事件時。當訂閱的事件發生時,Zonos 會向您指定的 Webhook URL 傳送 HTTP POST 請求。請求主體將包含事件詳細資訊,讓您的系統以程式設計方式處理該事件。

Webhook 適用於將 Zonos 與其他平台整合、觸發自動化工作流程,以及在即時系統中保持資料同步。例如,您可以使用 Webhook 來:

  • 在 Zonos 中建立訂單時更新訂單管理系統
  • 當貨運被取消時通知您的配送供應商
  • 記錄國際訂單的狀態變更以供稽核

Webhook 類型 

所有可用的 Webhook 類型都包含在 WebhookType 列舉中。每個類型的範例內容可以在我們的 Event Types 指南中找到。

建立 Webhook 

若要透過 API 建立 Webhook:

1mutation WebhookCreate($input: WebhookCreateInput!) {
2 webhookCreate(input: $input) {
3 id
4 url
5 type
6 status
7 }
8}

編輯 Webhook 詳細資訊 

若要透過 API 編輯現有 Webhook:

1mutation WebhookUpdate($input: WebhookUpdateInput!) {
2 webhookUpdate(input: $input) {
3 id
4 url
5 type
6 status
7 }
8}

檢視 Webhook 日誌 

若要透過 API 檢視 Webhook 日誌:

1query WebhookLogs(
2$first: Int
3$after: String
4$filter: WebhookLogsFilterInput
5) {
6 webhookLogs(first: $first, after: $after, filter: $filter) {
7 edges {
8 node {
9 id
10 type
11 url
12 createdAt
13 responseStatus
14 }
15 }
16 }
17}
GraphQL API ReferenceTypes, inputs, and operations used in this guide
預約演示

這個頁面有幫助嗎?