設定 Webhook

重要

這其中部分或所有的功能會做為預覽版本的一部分來提供。 內容和功能隨時可能變更。

需要為下列七個特定實體設定 Webhook：UserGroups、Categories、Users、UserGroupAssignments、Addresses、AddressAssignment、Catalogs. 本文會引導您完成為 Sitecore OrderCloud 連接器設定和啟動 Webhook 的步驟。

步驟 1： 在 OrderCloud 入口網站上設定 Webhook

此步驟需要指定每個 Webhook 的來源，以確保設定正確。

1. 移至 OrderCloud 入口網站 > API 主控台 > 傳遞設定 > POST 整合/deliveryconfig。 將名稱填入為 WebhooksDeliveryConfig，並標示為已啟用。

2. 向下捲動並找到事件中樞。 填入 Eventstream OrderCloud 來源的名稱和連接字串。 請選取傳送。 記下傳遞設定識別碼。

3. 移至 Webhook、選取左上角的閃電符號，然後切換至傳統檢視。

4. 對於七個實體中的每一個，您需要建立其各自的 Webhook。 對於每個 Webhook，選取 POST Webhook 端點並填入名稱。

5. 取代為每個 Webhook 的 Webhook JSON 中指定的 JSON。

6. 填入正確的 API 用戶端識別碼和傳遞設定識別碼。

步驟 2： 設定連接器上的 Webhook

此步驟需要指定每個 Webhook 的目的地，以確保設定正確。

1. 移至 Webhook Eventstream 資源。

2. 建立新的名為 OrderCloud 的自訂應用程式來源。

3. 為七個實體分別建立一個新的目的地。

4. 選取 Lakehouse 做為新的目的地。

5. 在 [目的地名稱] 和 [Delta 資料表] 欄位中，輸入實體名稱 (例如，類別)。

6. 輸入建立的銅級 Lakehouse 名稱和相關聯的工作區名稱。

   

7. 對其他六個實體重複這些步驟。

8. 建立所有七個目標後，選取全部停用。

步驟 3： 啟用已設定的 Webhook

設定 Webhook 的來源和目的地後，您必須加以啟用，以便在每次資料更新後觸發 Webhook。 現在，若要開始執行資料流程，您必須觸發 Webhook。 例如，您可以在來源端建立新的類別，並觀察目的地端複製該類別的情況。

1. 返回 Eventstream 來源。

2. 選取其區域中 Webhook 的相應波形圖示 (例如，類別)，並排列篩選條件。

3. 重複上述步驟以觸發其他六個 Webhook。 您可以在排列的實體區段中查看排列的實體。

4. 選取全部啟用。 現在，Eventstream 資源會同步已排列實體上的新作業。

Webhook 的 JSON

AddressAssignmentsWebhook

{
  "Name": "AddressAssignmentsWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
	"Route": "v1/buyers/{buyerID}/addresses/{addressID}/assignments",
	"Verb": "DELETE"
    },
    {
	"Route": "v1/buyers/{buyerID}/addresses/assignments",
	"Verb": "POST"
    }
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

AddressWebhook

{
  "Name": "AddressWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/buyers/{buyerID}/addresses",
					"Verb": "POST"
				},
				{
					"Route": "v1/buyers/{buyerID}/addresses/{addressID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/buyers/{buyerID}/addresses/{addressID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/buyers/{buyerID}/addresses/{addressID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

CatalogsWebhook

{
  "Name": "CatalogsWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/catalogs",
					"Verb": "POST"
				},
				{
					"Route": "v1/catalogs/{catalogID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/catalogs/{catalogID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/catalogs/{catalogID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

CategoriesWebhook

{
  "Name": "CategoriesWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/catalogs/{catalogID}/categories",
					"Verb": "POST"
				},
				{
					"Route": "v1/catalogs/{catalogID}/categories/{categoryID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/catalogs/{catalogID}/categories/{categoryID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/catalogs/{catalogID}/categories/{categoryID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

UserGroupAssignmentsWebhook

{
  "Name": "UserGroupAssignmentsWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "PUT"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}/assignments/{userID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/assignments",
					"Verb": "POST"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

UserGroupsWebhook

{
  "Name": "UserGroupsWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/buyers/{buyerID}/usergroups",
					"Verb": "POST"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

UsersWebhook

{
  "Name": "UsersWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/buyers/{buyerID}/users",
					"Verb": "POST"
				},
				{
					"Route": "v1/buyers/{buyerID}/users/{userID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/buyers/{buyerID}/users/{userID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/buyers/{buyerID}/users/{userID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

排列的實體

UserGroups

目錄

使用者

UserGroupAssignments

位址

AddressAssignment

目錄

重要

如需詳細支援，請透過 mcfrcommunity@microsoft.com 連絡 Microsoft Cloud for Retail 團隊。