建立 Webhook
Webhook 是一種可用於擷取及儲存特定事件之資料的工具,可讓您註冊 https://
URL,您的事件資料就能以 JSON 或 XML 格式儲存在此。通常因下列原因使用 Webhooks:
- 提交訂單
- 變更產品價格
- 在您處於離線狀態時通知您的即時通訊 (IM) 顧客端或傳呼機
- 為資料倉儲收集數據資料
- 整合會計帳務軟體
- 篩選訂單項目,並向各個託運人傳送訂單通知
- 當客戶取消安裝您的 App 時,從資料庫中移除客戶資料
支援的 Webhook 事件
建立 Webhook 時,您可選取列出的任何活動。例如,如要建立每次就訂單付款時傳送的 Webhook,請選取「訂單付款」。或者,如要建立每次更新商店屬性時傳送的 Webhook ,請選取「更新商店」。
類別 | 活動 |
---|---|
購物車 |
|
結帳 |
|
商品系列 |
|
客戶 |
|
折扣 |
|
訂單草稿 |
|
出貨作業 |
|
庫存 |
|
地點 |
|
行銷 |
|
訂單 |
|
產品 |
|
退款 |
|
Shop |
|
付款方式 |
|
佈景主題 |
|
交易 |
|
建立 Webhook
您隨時都可以建立 Webhook。您的 Webhook 會使用 ID 簽名,該 ID 由您商店獨有的字母和數字組合而成。
步驟如下:
電腦版
在 Shopify 管理介面 中,前往「設定」>「通知」。
按一下「Webhook」。
按一下「⊕ 建立 Webhook」。
在「事件」下拉式選單中,選取要用作 Webhook 活動的任何支援的 Webhook 事件。建立 Webhook 後,您將無法更改 Webhook 事件。
在「格式」下拉式選單中,選擇您想要 Shopify 用來傳送此資訊給您的格式。您可以選擇 JSON 或 XML 這兩種格式。
在「網址」欄位中,輸入您想要用來儲存資料的網址。Webhook 無法回傳下列網址:
- 本地主機
- 任何以「internal」結尾的網址(如
example.com/internal
) - 從任一自訂網域連結至此商店的網址
- 「假冒」的網域(如
www.example.com
) - Shopify 網域(如
shopify.com
和myshopify.com
)
在 Webhook API 版本中,選取您首選的 Webhook 版本。
按一下「儲存」。
iPhone
在 Shopify 應用程式中,點選「
」>「設定」。
在「商店設定」區段中,點選「通知」。
點選「Webhook」。
點選「⊕ 建立 Webhook」。
在「事件」下拉式選單中,選取要用作 Webhook 活動的任何支援的 Webhook 事件。建立 Webhook 後,您將無法更改 Webhook 事件。
在「格式」下拉式選單中,選擇您想要 Shopify 用來傳送此資訊給您的格式。您可以選擇 JSON 或 XML 這兩種格式。
在「網址」欄位中,輸入您想要用來儲存資料的網址。Webhook 無法回傳下列網址:
- 本地主機
- 任何以「internal」結尾的網址(如
example.com/internal
) - 從任一自訂網域連結至此商店的網址
- 「假冒」的網域(如
www.example.com
) - Shopify 網域(如
shopify.com
和myshopify.com
)
在 Webhook API 版本中,選取您首選的 Webhook 版本。
點選「儲存」。
Android
- 在 Shopify 應用程式中,點選「
」>「設定」。
- 在「商店設定」區段中,點選「通知」3. 點選「Webhook」。4. 點選「⊕建立 Webhook」。 5. 在「事件」下拉式選單中,選取要用作 Webhook 活動的任何支援的 Webhook 事件。建立 Webhook 後,您將無法更改 Webhook 事件。6. 在「格式」下拉式選單中,選擇您想要 Shopify 用來傳送此資訊給您的格式。有兩個選項 JSON 或 XML 可供選擇。 7. 在「網址」欄位中,輸入要儲存資料的網址。Webhook 無法傳回下列網址: * 本地主機 * 任何以「internal」結尾的網址 (例如
example.com/internal
) * 任何附加至商店的自訂網域網址 *「虛假」網域 (例如www.example.com
) * Shopify 網域 (例如shopify.com
和myshopify.com
) 8. 在 Webhook API 版本中,選取您偏好的 Webhook 版本。9. 點選「✓」。
儲存新 Webhook 後,它將顯示在「Webhook」頁面中。
編輯 Webhook
您可以在建立 Webhook 後編輯該 Webhook 的配置。但是,您無法修改所選的 Webhook 事件。
步驟如下:
電腦版
在 Shopify 管理介面 中,前往「設定」>「通知」。
按一下「Webhook」。
在包含要編輯的 Webhook 一列,按一下「…」>「編輯」。
在「編輯 Webhook」對話方塊中,根據需要修改 Webhook。
按一下「儲存」。
iPhone
在 Shopify 應用程式中,點選「
」>「設定」。
在「商店設定」區段中,點選「通知」。
點選「Webhook」。
在包含要編輯的 Webhook 一列,點選「…」>「編輯」。
在「編輯 Webhook」對話方塊中,根據需要修改 Webhook。
點選「儲存」。
Android
- 在 Shopify 應用程式中,點選「
」>「設定」。
- 在「商店設定」區段中,點選「通知」。3. 點選「Webhook」。4. 在包含您要編輯的 Webhook 那列,點選「…」>「編輯」。5. 在「編輯 Webhook」對話方塊中,視需求修改 Webhook。6. 點選「✓」。
測試 Webhook
此外,您可測試您的 Webhook,以確認您所需的事件資訊會傳送至正確網址。
步驟如下:
電腦版
在 Shopify 管理介面 中,前往「設定」>「通知」。
按一下「Webhook」。
在包含要測試的 Webhook 一列,點擊「…」>「發送測試」。
在為 Webhook 指定的網址上,驗證通知是否有效。
iPhone
在 Shopify 應用程式中,點選「
」>「設定」。
在「商店設定」區段中,點選「通知」。
點選「Webhook」。
在包含要測試的 Webhook 一列,點選「…」>「發送測試」。
在為 Webhook 指定的網址上,驗證通知是否有效。
Android
- 在 Shopify 應用程式中,點選「
」>「設定」。
- 在「商店設定」區段中,點選「通知」。3. 點選「Webhook」。4. 在包含您要測試的 Webhook 那列,點選「…」>「傳送測試」。5. 在為 Webhook 指定的網址上,驗證通知是否有效。
刪除 Webhook
您可以在 Shopify 管理介面刪除 Webhook。此動作無法復原。
步驟如下:
電腦版
在 Shopify 管理介面 中,前往「設定」>「通知」。
按一下「Webhook」。
在包含要刪除的 Webhook 一列,點擊「…」>「刪除」。
iPhone
在 Shopify 應用程式中,點選「
」>「設定」。
在「商店設定」區段中,點選「通知」。
點選「Webhook」。
在包含要刪除的 Webhook 一列,點選「…」>「刪除」。
Android
- 在 Shopify 應用程式中,點選「
」>「設定」。
- 在「商店設定」區段中,點選「通知」。3. 點選「Webhook」。4. 在包含您要刪除的 Webhook 那列,點選「…」>「刪除」。