Webhooks konfigurieren

Artikel
08/13/2024

Wichtig

Einige oder alle dieser Funktionen sind als Teil einer Vorschauversion verfügbar. Inhalt und Funktionalität können sich ändern.

Webhooks müssen für sieben bestimmte Entitäten konfiguriert werden: Benutzergruppen, Kategorien, Benutzer, Benutzergruppenzuweisungen, Adressen, Adresszuweisungen, Kataloge. Dieser Artikel führt Sie durch die Schritte zum Konfigurieren und Aktivieren der Webhooks für den Sitecore OrderCloud-Konnektor.

Schritt 1. Webhooks im OrderCloud-Portal konfigurieren

Dieses Schritt erfordert die Angabe der Quelle für jeden Webhook, um die richtige Konfiguration sicherzustellen.

Gehe zu OrderCloud Portal > API-Konsole > Lieferkonfigurationen > POST-Integrationen/Lieferkonfiguration. Name ausfüllen als WebhooksDeliveryConfig, als aktiviert markieren.
Scrollen Sie nach unten und finden Sie Event Hub. Füllen Sie Name und Verbindungszeichenfolge aus der Eventstream OrderCloud-Quelle aus. Wählen Sie Absenden aus. Notieren Sie die Delivery Config ID.
Gehen Sie zu Webhooks, wählen den leuchtenden Blitz in der oberen linken Ecke und wechseln zur klassischen Ansicht.
Für jede der sieben Entitäten müssen Sie jeweils einen Webhook erstellen. Für jeden Webhook POST-Webhook-Endpunkt auswählen und den Namen ausfüllen.
Den vorgegebenen JSON-Code in JSON für Webhooks für jeden Webhook ersetzen.
Geben Sie die korrekte API-Client-ID und Delivery-Config-ID ein.

Schritt 2. Konfigurieren Sie Webhooks im Konnektor

Dieses Schritt erfordert die Angabe des Ziels für jeden Webhook, um die richtige Konfiguration sicherzustellen.

Gehen Sie zu Ihrer Webhooks-Eventstream-Ressource.
Erstellen Sie eine neue benutzerdefinierte App-Quelle mit dem Namen OrderCloud.
Erstellen Sie ein neues Ziel für jede der sieben Entitäten.
Lakehouse als neues Ziel auswählen.
Geben Sie in den Feldern „Zielname“ und „Deltatabelle“ den Entitätsnamen ein (z. B. Kategorien).
Geben Sie den erstellten Bronze-Namen Lakehouse und den zugehörigen Arbeitsbereichsnamen ein.
Wiederholen Sie diese Schritte für die sechs Entitäten.
Nachdem alle sieben Ziele erstellt wurden, wählen Sie Alle deaktivieren.

Schritt 3. Aktivieren Sie die konfigurierten Webhooks

Nachdem Quelle und Ziel für die Webhooks konfiguriert sind, müssen Sie diese aktivieren, damit die Webhooks bei jeder Datenaktualisierung ausgelöst werden. Um nun den Datenfluss zu starten, sollten Sie den Webhook auslösen. Sie können beispielsweise auf der Quellseite eine neue Kategorie erstellen und beobachten, wie sie auf der Zielseite repliziert wird.

Zurück zur Eventstream-Quelle.
Das entsprechende Zyklus-Symbol für einen Webhook in ihrem Bereich (z. B. Kategorien) auswählen und die Filter arrangieren.
Wiederholen Sie die Schritte, um die anderen sechs Webhooks mit Trigger zu versehen. Sie können die angeordneten Entitäten im Angeordnete Entitäten Abschnitt sehen.
Wählen Sie Alle aktivieren. Jetzt synchronisiert die Eventstream-Ressource die neuen Vorgänge mit den angeordneten Entitäten.

JSON für Webhooks

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