Webhooks を構成する

[アーティクル]
11/25/2024

重要

この機能の一部またはすべては、プレビューリリースの一部として利用できます。コンテンツおよび機能は変更される場合があります。

Webhook は、UserGroups、Categories、Users、UserGroupAssignments、Addresses、AddressAssignment、Catalogs の 7 つの特定のエンティティに対して構成する必要があります。この記事では、Sitecore OrderCloud コネクタの Webhook を構成してアクティブ化する手順について説明します。

ステップ 1. OrderCloud ポータルで Webhook を設定する

この手順では、各 Webhook のソースを指定して、適切な構成を確保する必要があります。

OrderCloudポータル > APIコンソール > 配送構成 > POST 統合/配信構成 に移動します。 WebhooksDeliveryConfig とファイル名を指定し、マークを有効化します。
下にスクロールして イベントハブを見つけます。 Eventstream OrderCloud ソースから名前と接続文字列を入力します。送信を選択します。 配信設定 ID をメモします。
Webhooks に移動し、左上の稲妻を選択し、クラシック表示に切り替えます。
7 つのエンティティごとに、それぞれ Webhook を作成する必要があります。各 Webhook について、選択 POST Webhook エンドポイントを入力し、名前を入力します。
各 webhook の webhook 用 JSON で指定された JSON に置き換えます。
正しい API クライアント ID と配信設定 ID を入力してください。

ステップ 2. コネクター上の Webhooks の構成

この手順では、各 Webhook の展開先を指定して、適切な構成を確保する必要があります。

Webhooks Eventstream リソースに移動します。
新しいカスタムアプリソース OrderCloud を作成します。
7 つのエンティティにそれぞれ新しい対象を作成します。
新しい対象として レイクハウス を選択します。
Destination 名と Delta テーブルフィールドに、エンティティ名 (Categories) を入力します。
作成された Bronze レイクハウス名と関連するワークスペース名を入力します。
他の 6 つのエンティティに対してこれらの手順を繰り返します。
7 つの対象をすべて作成した後、すべて無効にするを選択します。

ステップ 3. 構成された Webhook を有効化する

Webhook のソースと宛先を設定したら、データの更新ごとに Webhook がトリガーされるようにアクティブ化する必要があります。ここで、データフローを開始するには、Webhook をトリガーする必要があります。たとえば、ソース側で新しいカテゴリを作成し、それが対象となる側で複製されるのを確認できます。

Eventstream ソースに戻ります。
webhook に関連するウェーブアイコンを選択し、フィルターをアレンジします。
残りの 6 つの Webhook に対しても手順を繰り返してトリガーを実行します。配置されたエンティティは、配置されたエンティティ セクションで確認できます。
すべてアクティブ化するを選択します。これで、Eventstream リソースは配置されたエンティティに対する新しい操作を同期します。

WebHooks 用 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>"
}