DokumentationExperience PlatformTaggar

Översikt över tillägget Zendesk för API:t för händelser

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare

Zendesk är en kundtjänst och ett säljverktyg. Tillägget Zendesk Events API används för att skicka händelser från Adobe Experience Platform Edge Network till Zendesk för vidare bearbetning, vilket innebär att händelsen vidarebefordras. Du kan använda tillägget för att samla in interaktioner med kundprofiler för användning i analyser och åtgärder längre fram i kedjan.

Det här dokumentet beskriver hur du installerar och konfigurerar tillägget i användargränssnittet.

Förhandskrav

Du måste ha ett Zendesk-konto för att kunna använda det här tillägget. Du kan registrera dig för ett Zendesk-konto på Zendesk-webbplatsen.

Du måste även samla in följande information för din Zendesk-konfiguration:

Nyckeltyp
Beskrivning
Exempel
Underdomän
Under registreringsprocessen skapas en unik underdomän som är specifik för kontot. Mer information finns i Zendesk-dokumentationen.
xxxxx.zendesk.com (där xxxxx är värdet som angavs när kontot skapades)
API-token
Zendesk använder bearer-tokens som en autentiseringsmekanism för att kommunicera med Zendesk API. Generera en API-token när du har loggat in på Zendesk-portalen. Mer information finns i Zendesk-dokumentationen.
cwWyOtHAv12w4dhpiulfe9BdZFTz3OKaTSzn2QvV

Slutligen måste du skapa en händelsevidarebefordringshemlighet för API-token. Ange den hemliga typen till Token och ange värdet till den API-token som du samlade in från din Zendesk-konfiguration. Mer information om hur du konfigurerar hemligheter finns i dokumentationen om hemligheter i händelsevidarebefordran.

Installera tillägget install

Om du vill installera Zendesk-tillägget i användargränssnittet går du till Vidarebefordra händelser och väljer en egenskap som tillägget ska läggas till i. Du kan också skapa en ny egenskap i stället.

När du har markerat eller skapat den önskade egenskapen går du till Tillägg > Katalog. Sök efter Zendesk och välj sedan Install i Zendesk-tillägget.

Installationsknappen för Zendesk-tillägget som väljs i användargränssnittet

Konfigurera tillägget configure

IMPORTANT
Beroende på ditt implementeringsbehov kan du behöva skapa ett schema, dataelement och en datauppsättning innan du konfigurerar tillägget. Granska alla konfigurationssteg innan du startar för att avgöra vilka enheter du måste konfigurera för ditt användningsfall.

Välj Tillägg i den vänstra navigeringen. Under Installerad väljer du Konfigurera i Zendesk-tillägget.

Konfigurera-knappen för Zendesk-tillägget som väljs i användargränssnittet

Under Zendesk Domain anger du värdet för din Zendesk-underdomän. Under Zendesk Token väljer du den hemlighet som du skapade tidigare och som innehåller API-token.

Konfigurationsalternativen är ifyllda i användargränssnittet

Konfigurera en regel för vidarebefordran av händelser

Börja skapa en ny regel för vidarebefordran av händelse regel och konfigurera villkoren efter behov. När du väljer åtgärder för regeln väljer du tillägget Zendesk och sedan åtgärdstypen Create Event.

Definiera regel

När du konfigurerar åtgärdskonfigurationen uppmanas du att tilldela dataelement till de olika egenskaper som ska skickas till Zendesk.

Definiera åtgärdskonfiguration

Dessa dataelement ska mappas enligt nedan.

event tangenter

event är ett JSON-objekt som representerar den händelse som utlöses av användaren. Se Zendesk-dokumentet på anatomin för en händelse om du vill ha mer information om egenskaperna som har hämtats av event-objektet.

Följande nycklar kan refereras inom objektet event vid mappning till dataelement:

event-tangenten
Typ
Plattformssökväg
Beskrivning
Obligatoriskt
Gränser
source
Sträng
arc.event.xdm._extconndev.event_source
Programmet som skickade händelsen.
Ja
Använd inte Zendesk som ett värde eftersom det är ett skyddat källnamn för Zendesk-standardhändelser. Försök att använda den kommer att resultera i ett fel.
Värdet får inte vara längre än 40 tecken.
type
Sträng
arc.event.xdm._extconndev.event_type
Ett namn för händelsetypen. Du kan använda det här fältet för att ange olika typer av händelser för en viss källa. Du kan till exempel skapa en uppsättning händelser för användarinloggningar och en annan för kundvagnar.
Ja
Värdet får inte vara längre än 40 tecken.
description
Sträng
arc.event.xdm._extconndev.description
En beskrivning av händelsen.
Nej
(Ej tillämpligt)
created_at
Sträng
arc.event.xdm.timestamp
En ISO-8601-tidsstämpel som visar när händelsen skapades.
Nej
(Ej tillämpligt)
properties
Objekt
arc.event.xdm._extconndev.EventProperties
Ett anpassat JSON-objekt med information om händelsen.
Ja
(Ej tillämpligt)
NOTE
Mer information om händelseegenskaper finns i Zendesk Events API dokumentationen.

profile tangenter

profile är ett JSON-objekt som representerar användaren som utlöste händelsen. Mer information om egenskaperna som har hämtats av objektet profile finns i Zendesk-dokumentet på anatomin för en profil.

Följande nycklar kan refereras inom objektet profile vid mappning till dataelement:

profile-tangenten
Typ
Plattformssökväg
Beskrivning
Obligatoriskt
Gränser
source
Sträng
arc.event.xdm._extconndev.profile_source
Produkten eller tjänsten som är associerad med profilen, till exempel Support, CompanyName eller Chat.
Ja
(Ej tillämpligt)
type
Sträng
arc.event.xdm._extconndev.profile_type
Ett namn för profiltypen. Du kan använda det här fältet för att skapa olika typer av profiler för en viss källa. Du kan till exempel skapa en uppsättning företagsprofiler för kunder och en annan för anställda.
Ja
Profiltypens längd får inte överstiga 40 tecken.
name
Sträng
arc.event.xdm._extconndev.name
Namnet på personen från profilen
Nej
(Ej tillämpligt)
user_id
Sträng
arc.event.xdm._extconndev.user_id
Personens användar-ID i Zendesk.
Nej
(Ej tillämpligt)
identifiers
Array
arc.event.xdm._extconndev.identifiers
En array som innehåller minst en identifierare. Varje identifierare består av en typ och ett värde.
Ja
Mer information om identifiers-arrayen finns i Zendesk-dokumentationen. Alla fält och värden måste vara unika.
attributes
Objekt
arc.event.xdm._extconndev.attrbutes
Ett objekt som innehåller användardefinierade egenskaper för personen.
Nej
Mer information om profilattribut finns i Zendesk-dokumentationen.

Validera data i Zendesk validate

Om händelseinsamlingen och Adobe Experience Platform-integreringen lyckas visas händelserna i Zendesk-konsolen enligt nedan. Detta indikerar en lyckad integrering.

Profiler:

Sidan Zendesk-profiler

Händelser:

Sidan Zendesk Events

Begärandebegränsningar limits

Baserat på kontotypen kan Zendesk Events API hantera följande antal begäranden per minut:

Account Type
Begäranden per minut
Team
250
Growth
250
Professional
500
Enterprise
750
Enterprise Plus
1000

Mer information om dessa begränsningar finns i Zendesk-dokumentationen.

Fel och felsökning errors-and-troubleshooting

När tillägget används eller konfigureras kan felen nedan returneras av Zendesk Events-API:

Felkod
Beskrivning
Upplösning
Exempel
400
Ogiltig profillängd: Det här felet inträffar när längden på ett profilattribut innehåller mer än 40 tecken.
Begränsa längden på profilattributsdata till högst 40 tecken.
{"error": [{"code":"InvalidProfileTypeLength","title": "Profile type length > 40 chars"}]}
401
Det gick inte att hitta vägen: Det här felet inträffar när en ogiltig domän har angetts.
Kontrollera att en giltig domän har angetts i följande format: {subdomain}.zendesk.com
{"error": [{"description": "No route found for host {subdomain}.zendesk.com","title": "RouteNotFound"}]}
401
Ogiltig eller saknad autentisering: Det här felet inträffar när åtkomst till token är ogiltig, saknas eller har upphört att gälla.
Kontrollera att åtkomsttoken är giltig och inte har gått ut.
{"error": [{"code":"MissingOrInvalidAuthentication","title": "Invalid or Missing Authentication"}]}
403
Otillräckliga behörigheter: Det här felet inträffar när det inte finns tillräcklig behörighet för att komma åt resursen.
Verifiera att de nödvändiga behörigheterna har angetts.
{"error": [{"code":"PermissionDenied","title": "Insufficient permisssions to perform operation"}]}
429
För många begäranden: Det här felet inträffar när postgränsen för slutpunktsobjekt har överskridits.
Mer information om tröskelvärden per gräns finns i avsnittet ovan om begärandegränser.
{"error": [{"code":"TooManyRequests","title": "Too Many Requests"}]}

Nästa steg

I det här dokumentet beskrivs hur du installerar och konfigurerar tillägget för vidarebefordran av Zendesk-händelser i användargränssnittet. Mer information om hur du samlar in händelsedata i Zendesk finns i den officiella dokumentationen:

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743