Konfigurera webhooks

Artikel
11/25/2024

Viktigt

Några eller alla dessa funktioner ingår som en del av en förhandsversion. Innehållet och funktionerna kan komma att ändras.

Webhooks måste konfigureras för sju specifika entiteter: UserGroups, Categories, Users,UserGroupAssignments,Addresses,AddressAssignment,Catalogs. Den här artikeln innehåller steg-för-steg-instruktioner om hur du konfigurerar och aktiverar webhooks för Sitecore OrderCloud-anslutningsprogram.

Steg 1. Konfigurera Webhooks på OrderCloud-portalen

Den steg måste ange källan för varje webhook för att säkerställa att de är korrekt konfigurerade.

Gå till OrderCloud-portalen > API-konsol > Leveranssätt > POST-integrationer/deliveryconfig. Fyll i namnet WebhooksDeliveryConfig, markera aktiverat.
Bläddra nedåt och leta upp Event Hub. Fyll i namn och anslutningssträng från Eventstream OrderCloud-källan. Välj Skicka. Observera leveranskonfigurations-ID.
Gå till Webhooks, välj blixtsymbolen högst upp till vänster och växla till Klassisk vy.
För varje entitet måste du skapa en webhook varje. För varje webhook, välj POST webhook-slutpunkt och fyll i namnet.
Ersätt med JSON som anges i JSON för webhooks för varje webhook.
Fyll i rätt API-klient-ID och leveranskonfigurations-ID.

Steg 2. Konfigurera Webhooks på kontakten

Den steg måste ange destination för varje webhook för att säkerställa att de är korrekt konfigurerade.

Gå till din Webhooks Eventstream-resurs.
Skapa en ny anpassad appkälla som heter OrderCloud.
Skapa en ny destination var för de sju entiteterna.
Välj Sjöhus till ny destination.
I fälten Destinationsnamn och Delta-tabell anger du enhetsnamnet (Kategorier, som exempel).
Ange det skapade Bronze Lakehouse-namnet och det tillhörande arbetsytans namn.
Upprepa dessa steg för de övriga sex entiteterna.
När du har skapat alla de sju destinationerna väljer du Inaktivera alla.

Steg 3. Aktivera de konfigurerade Webhooks

När källan och destinationen för webhooks har konfigurerats måste du aktivera dem så att Webhooks utlöses med varje datauppdatering. Nu, för att initiera dataflödet, bör du utlösa webhook. Du kan till exempel skapa en ny kategori på källsidan och se den replikeras på målsidan.

Gå tillbaka till Eventstream-källan.
Välj relevant vågikon för en webhook inom deras område (till exempel Kategorier) och arrangera filter.
Upprepa proceduren för att utlösa de andra sex webhooks. De arrangerade entiteterna visas i avsnittet Arrangerade entiteter.
Välj Aktivera alla. Nu synkroniserar Eventstream-resursen de nya operationerna på arrangerade enheter.

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