DocumentazioneExperience PlatformTag

Panoramica dell'estensione API Zendesk Events

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

Creato per:

  • Sviluppatore

Zendesk è una soluzione di assistenza clienti e uno strumento di vendita. L'estensione event forwarding di Zendesk sfrutta Zendesk Events API per inviare eventi dall'Edge Network di Adobe Experience Platform a Zendesk per ulteriore elaborazione. Puoi utilizzare l’estensione per raccogliere le interazioni del profilo cliente da utilizzare nell’analisi e nell’azione a valle.

Questo documento illustra come installare e configurare l’estensione nell’interfaccia utente di.

Prerequisiti

Per utilizzare questa estensione è necessario disporre di un account Zendesk. Puoi registrarti per un account Zendesk sul sito Web Zendesk.

È inoltre necessario raccogliere i seguenti dettagli per la configurazione Zendesk:

Tipo di chiave
Descrizione
Esempio
Subdomain
Durante il processo di registrazione, viene creato un sottodominio univoco specifico per l'account. Per ulteriori informazioni, consulta la documentazione di Zendesk.
xxxxx.zendesk.com (dove xxxxx è il valore fornito durante la creazione dell'account)
Token API
Zendesk utilizza token bearer come meccanismo di autenticazione per comunicare con l’API di Zendesk. Dopo aver effettuato l’accesso al portale Zendesk, genera un token API. Per ulteriori informazioni, consulta la documentazione di Zendesk.
cwWyOtHAv12w4dhpiulfe9BdZFTz3OKaTSzn2QvV

Infine, devi creare un segreto per l’inoltro degli eventi per il token API. Imposta il tipo segreto su Token e imposta il valore sul token API raccolto dalla configurazione Zendesk. Per ulteriori informazioni sulla configurazione dei segreti, consulta la documentazione su segreti nell'inoltro degli eventi.

Installare l’estensione install

Per installare l'estensione Zendesk nell'interfaccia utente, passa a Inoltro eventi e seleziona una proprietà a cui aggiungere l'estensione oppure crea una nuova proprietà.

Dopo aver selezionato o creato la proprietà desiderata, passa a Estensioni > Catalogo. Cercare "Zendesk", quindi selezionare Install nell'estensione Zendesk.

Pulsante Installa per lestensione Zendesk selezionata nellinterfaccia utente

Configurare l'estensione configure

IMPORTANT
A seconda delle esigenze di implementazione, potrebbe essere necessario creare uno schema, elementi di dati e un set di dati prima di configurare l’estensione. Prima di iniziare, controlla tutti i passaggi di configurazione per determinare quali entità devi impostare per il tuo caso d’uso.

Seleziona Estensioni nel menu di navigazione a sinistra. In Installato, seleziona Configura nell'estensione Zendesk.

Pulsante Configura per lestensione Zendesk selezionata nellinterfaccia utente

In Dominio Zendesk, immetti il valore per il sottodominio Zendesk. In Token Zendesk, seleziona il segreto creato in precedenza che contiene il token API.

Opzioni di configurazione compilate nellinterfaccia utente

Configurare una regola di inoltro degli eventi

Inizia a creare una nuova regola di inoltro eventi regola e configurane le condizioni come desiderato. Quando selezioni le azioni per la regola, seleziona l'estensione Zendesk, quindi seleziona il tipo di azione Crea evento.

Definisci regola

Quando si imposta la configurazione dell’azione, viene richiesto di assegnare elementi dati alle varie proprietà che verranno inviate a Zendesk.

Definisci configurazione azione

Questi elementi dati devono essere mappati come indicato di seguito.

event chiavi

event è un oggetto JSON che rappresenta l'evento attivato dall'utente. Per ulteriori informazioni sulle proprietà acquisite dall'oggetto event, consultare il documento Zendesk sull'anatomia di un evento.

È possibile fare riferimento alle chiavi seguenti all'interno dell'oggetto event durante il mapping agli elementi dati:

Chiave event
Tipo
Percorso piattaforma
Descrizione
Obbligatorio
Limiti
source
Stringa
arc.event.xdm._extconndev.event_source
Applicazione che ha inviato l'evento.
Sì
Non utilizzare Zendesk come valore poiché è un nome di origine protetto per gli eventi standard Zendesk. I tentativi di utilizzarlo genereranno un errore.
La lunghezza del valore non deve superare i 40 caratteri.
type
Stringa
arc.event.xdm._extconndev.event_type
Nome per il tipo di evento. È possibile utilizzare questo campo per indicare diversi tipi di eventi per una determinata origine. Ad esempio, puoi creare un set di eventi per gli accessi degli utenti e un altro per i carrelli acquisti.
Sì
La lunghezza del valore non deve superare i 40 caratteri.
description
Stringa
arc.event.xdm._extconndev.description
Descrizione dell'evento.
No
(N/D)
created_at
Stringa
arc.event.xdm.timestamp
Una marca temporale ISO-8601 che riflette l’ora di creazione dell’evento.
No
(N/D)
properties
Oggetto
arc.event.xdm._extconndev.EventProperties
Oggetto JSON personalizzato con dettagli sull’evento.
Sì
(N/D)
NOTE
Per ulteriori informazioni sulle proprietà dell'evento, consultare la Zendesk Events API documentazione.

profile chiavi

profile è un oggetto JSON che rappresenta l'utente che ha attivato l'evento. Per ulteriori informazioni sulle proprietà acquisite dall'oggetto profile, consultare il documento Zendesk sull'anatomia di un profilo.

È possibile fare riferimento alle chiavi seguenti all'interno dell'oggetto profile durante il mapping agli elementi dati:

Chiave profile
Tipo
Percorso piattaforma
Descrizione
Obbligatorio
Limiti
source
Stringa
arc.event.xdm._extconndev.profile_source
Prodotto o servizio associato al profilo, ad esempio Support, CompanyName o Chat.
Sì
(N/D)
type
Stringa
arc.event.xdm._extconndev.profile_type
Nome per il tipo di profilo. Puoi utilizzare questo campo per creare diversi tipi di profili per una determinata origine. Ad esempio, puoi creare un set di profili aziendali per i clienti e un altro per i dipendenti.
Sì
La lunghezza del tipo di profilo non deve superare i 40 caratteri.
name
Stringa
arc.event.xdm._extconndev.name
Nome della persona dal profilo
No
(N/D)
user_id
Stringa
arc.event.xdm._extconndev.user_id
ID utente della persona in Zendesk.
No
(N/D)
identifiers
Array
arc.event.xdm._extconndev.identifiers
Matrice contenente almeno un identificatore. Ogni identificatore è costituito da un tipo e da un valore.
Sì
Per ulteriori informazioni sull'array identifiers, consultare la documentazione di Zendesk. Tutti i campi e i valori devono essere univoci.
attributes
Oggetto
arc.event.xdm._extconndev.attrbutes
Oggetto contenente le proprietà definite dall’utente sulla persona.
No
Per ulteriori informazioni sugli attributi del profilo, consulta la documentazione di Zendesk.

Convalidare i dati in Zendesk validate

Se la raccolta di eventi e l’integrazione di Adobe Experience Platform hanno esito positivo, gli eventi all’interno della console Zendesk dovrebbero apparire come mostrato di seguito. Ciò indica un’integrazione riuscita.

Profili:

Pagina Profili Zendesk

Eventi:

Pagina eventi Zendesk

Limiti di richieste limits

In base al tipo di account, Zendesk Events API è in grado di gestire il seguente numero di richieste al minuto:

Account Type
Richieste al minuto
Team
250
Growth
250
Professional
500
Enterprise
750
Enterprise Plus
1000

Per ulteriori informazioni su questi limiti, consulta la documentazione di Zendesk.

Errori e risoluzione problemi errors-and-troubleshooting

Durante l’utilizzo o la configurazione dell’estensione, l’API degli eventi Zendesk potrebbe restituire gli errori seguenti:

Codice di errore
Descrizione
Risoluzione
Esempio
400
Lunghezza profilo non valida: Questo errore si verifica quando la lunghezza di un attributo di profilo contiene più di 40 caratteri.
Limita la lunghezza dei dati dell’attributo del profilo a un massimo di 40 caratteri.
{"error": [{"code":"InvalidProfileTypeLength","title": "Profile type length > 40 chars"}]}
401
Route non trovata: Questo errore si verifica quando è stato fornito un dominio non valido.
Verificare che sia fornito un dominio valido nel seguente formato: {subdomain}.zendesk.com
{"error": [{"description": "No route found for host {subdomain}.zendesk.com","title": "RouteNotFound"}]}
401
Autenticazione non valida o mancante: Questo errore si verifica quando l'accesso al token non è valido, è mancante o è scaduto.
Verifica che il token di accesso sia valido e non sia scaduto.
{"error": [{"code":"MissingOrInvalidAuthentication","title": "Invalid or Missing Authentication"}]}
403
Autorizzazioni insufficienti: Questo errore si verifica quando non sono state fornite autorizzazioni sufficienti per accedere alla risorsa.
Verifica che siano state fornite le autorizzazioni necessarie.
{"error": [{"code":"PermissionDenied","title": "Insufficient permisssions to perform operation"}]}
429
Troppe richieste: Questo errore si verifica quando viene superato il limite di record dell'oggetto endpoint.
Per informazioni sulle soglie per limite, consulta la sezione precedente sui limiti di richiesta.
{"error": [{"code":"TooManyRequests","title": "Too Many Requests"}]}

Passaggi successivi

Questo documento illustra come installare e configurare l’estensione di inoltro degli eventi Zendesk nell’interfaccia utente. Per ulteriori informazioni sulla raccolta dei dati sull’evento in Zendesk, consulta la documentazione ufficiale:

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