JSON-Ereignis
Was finden Sie hier?
TIPP: JSON Ereignisse sind nur für Benutzer verfügbar, die Zugang zur Qualtrics API erworben haben. Wenn Sie an dieser Funktion interessiert sind, wenden Sie sich an Ihren Account Executive oder den Benutzerkonto-Service.
Über das Ereignis JSON
Wollten Sie schon einmal eine Anfrage auf Ihrer Website stellen, um ein Ticket in Qualtrics Auslöser? Wollten Sie schon einmal eine nahtlose Integration zwischen Qualtrics und Ihrem eigenen internen System schaffen? Wollten Sie schon einmal eine Aufgabe auf der Registerkarte Workflows Auslöser, aber mit einem Ereignis, das außerhalb von Qualtrics eintritt?
JSON ermöglichen es externer Software, Workflows über einen HTTP-Request zu starten. Anstatt auf ein Ereignis in Qualtrics zu warten, das weitere Aktionen in der Plattform auslöst, können Sie einfach ein JSON-Ereignis konfigurieren, um Anfragen von Dritten zu erhalten.
Tipp: Sie müssen API-Token generieren bevor Ihnen diese Funktion zur Verfügung steht. Wenn Sie bereits über ein API-Token verfügen, müssen Sie kein neues generieren.
Achtung: ! Das Einrichten eines JSON-Ereignisses erfordert fortgeschrittene Programmierkenntnisse. Unser Support-Team hilft zwar gerne bei den Grundlagen, Informationen in die Ereignis einzubringen, aber wir können keine Unterstützung in Bezug auf die Programmieraspekte leisten. Stattdessen können Sie sich gerne in unserer Benutzer-Community erkundigen.
Einschränkungen
Das EREIGNIS JSON ist mit den folgenden Einrichtungen und Konfigurationen nicht kompatibel:
- Alles, was nicht HTTP ist (z.B. Nachrichtenwarteschlange, SMS).
- Ausgehende HTTP-Aufrufe.
- XML verarbeiten (der XML wird ignoriert).
- Verarbeiten Sie alles andere als JSON.
- Authentifizieren Sie auf andere Weise als einen X-API-TOKEN-Header oder unsere modifizierte HTTP-Basisberechtigung. Tipp: OAuth und andere Authentifizierungsformen sind mit JSON nicht kompatibel.
- Jegliches JSON, das nicht durch die Verwendung von JSONPath-Abfragen im JSON erfüllt werden kann.
- Aufrufe, die das API von 3.000 pro Minute überschreiten.
- Payloads größer als 100 KB.
- 10 manuell einzugebende Felder. TIPP: Sobald Informationen mit der Erfassung von Ereignissen eingezogen werden, werden sie dem JSON-Body hinzugefügt. Die Erfassung von Ereignissen ist die einzige Möglichkeit, mehr als 10 Felder hinzuzufügen.
Unterstützte Berechtigungstypen
Token-basierte Authentifizierung/Kopfauthentifizierung
Sie können sich authentifizieren, indem Sie Ihr API-Token über den Header der Anforderung als X-API-TOKEN.
Beispiel: Im folgenden POST-Beispiel geben wir in cURL die URL, den Content-Type und das Token im Header an. Die Umfrage-ID und das Exportformat werden im Body angegeben
.curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{
”
surveyId": "SV_012345678912345",
"format": "csv"
}' 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'
HTTP-Basisauthentifizierung
Basic Auth ist in der Regel eine Base64-kodierte Version von username:password. Aus Sicherheitsgründen verwendet Qualtrics jedoch eine Base64-kodierte Zeichenfolge mit dem Benutzernamen:x-api-token.
Um Basic Auth zu verwenden, müssen Sie Header für den HTTP-Request festlegen. Der spezifische Kopf lautet Berechtigung.
Beispiel: Angenommen, Ihr Qualtrics lautet qualtrics und Ihr API ist f8gIK7G6GFH985Y4. Zuerst würden Sie schreiben,
qualtrics:f8gIK7G6GFH985Y4Nach der Base64-Kodierung würde dies wie folgt aussehen:
Basic ZGVtb0BxdWFsdHJpY3MuY29tOmY4Z0lLN0c2R0ZIOTg1WTQ=Also wird die Berechtigung Header, den Sie Ihrem HTTP-Request hinzufügen, den Wert Basic ZGVtb0BxdWFsdHJpY3MuY29tOmY4Z0lLN0c2R0ZIOTg1WTQ=.
Tipp: Sehen Sie sich diese Werkzeuge für an Kodierung Base64 und Dekodierung Base64.
Einrichten eines JSON-Ereignisses
TIPP: Klicken Sie auf Ihr JSON-Ereignis, um die Parameter und JSON-Felder zu ändern.
Achtung!: Ein JSON-Ereignis kann nur über die API von demselben Benutzerkonto abgefeuert werden, das das Ereignis erstellt hat. Wenn ein anderes Benutzerkonto zum Auslösen der API für ein JSON-Ereignis verwendet wird, erhalten Sie möglicherweise eine API-Antwort mit dem Wert 202 – Erfolg. Dies bedeutet jedoch, dass ein gültiges API-Token verwendet wurde, um eine gültige Anfrage zu stellen, aber nicht unbedingt, dass das richtige API-Token verwendet wurde oder dass das JSON-Ereignis korrekt ausgelöst wurde. Wenn Sie eine API erhalten, möchten Sie die Plattform prüfen, um zu bestätigen, dass das richtige API verwendet wurde.
Ereignisse erfassen
Wenn Sie ein externes API-Ereignis erstellen, müssen Sie möglicherweise Daten aus dem Post-Body auswerten. Es kann jedoch manchmal schwierig sein, diese Daten zu parsen. Wenn Sie herausfinden möchten, was Ihr externes API sendet, führen Sie die folgenden Schritte aus.
JSONPath-Syntax
Die folgende Tabelle enthält einige Grundlagen der JSONPath-Syntax. Beachten Sie, dass diese nicht von Qualtrics eingerichtet werden, sondern Standards sind, die mit JSON verwendet werden.
Achtung: ! Das Einrichten eines JSON-Ereignisses erfordert fortgeschrittene Programmierkenntnisse. Unser Support-Team hilft zwar gerne bei den Grundlagen, Informationen in die Ereignis einzubringen, aber wir können keine Unterstützung in Bezug auf die Programmieraspekte leisten. Sie können immer versuchen, unsere Community mit dedizierten Benutzern statt dessen.
| JSON-Pfad | Beschreibung | Beispiel |
|---|---|---|
| $ | Wurzelobjekt/-element | $.store[0].name |
| @ | Das aktuelle Objekt/Element | $.store[?(@.name===”ACME Store”)] |
| . | Untergeordneter Operator | $.eventDescription |
| .. | Rekursiver Nachfahrenoperator | $.Stores[0]..Preis |
| * | Platzhalter | $.store[*].name |
| [] | Subskriptoperator | $.store[0].name |
| [,] | Union-Operator | $.shops[0,1] |
| [Start:Ende:Schritt] | Array-Slice-Operator | $.shops[0:10:2] |
| ?() | Wendet einen Filter an | $.store[?(@.name==”ACME Store”)] |
| () | Skriptausdruck | $.store[(@.length-1)] |
JSONPath-Syntaxbeispiel
In diesem Beispiel wird gezeigt, wie die JSONPath-Tabelle bei einem JSON verwendet werden kann.
Dies ist unser JSON:
{
"eventDescription": "Monatlicher Umsatz",
"Stores": [
{
"name": "Acme Store",
"total": 1000000,
"topItem":
{ "price": "50", "description": "Anvil" }
},
{
"Name": "The Banana Stand",
"total": 250000,
"topItem":
{ "Preis": "4", "Beschreibung": "The Gob" }
},
{
"Name": "Pizza Planet",
"total": 80000,
"topItem":
{ "price": "15", "description": "Pepperoni" }
}
]
}
Nun sollten wir die Rückgabewerte hinzufügen, die in der JSONPath-Tabelle angezeigt werden, um sie klarer zu machen.
$ -> Acme Store
@ -> [
{
"name": "Acme Store",
"total": 1000000,
"topItem":
{ "price": "50", "description": "Anvil" }
}
]
. -> Monatlicher Umsatz
.. -> 50
-> ["Acme Store", "The Banana Stand", "Pizza Planet"]
[] -> Acme Store
[,] -> [
Unbekanntes Makro: { "name"}
,
Unbekanntes Makro: { "name"}
]
**Ändern Sie das Beispiel von [start:end:step] in "$.stores[1:3:1]".
[start:end:step] -> [
{
"Name": "The Banana Stand",
"total": 250000,
"topItem":
{ "Preis": "4", "Beschreibung": "The Gob" }
},
{
"Name": "Pizza Planet",
"total": 80000,
"topItem":
{ "price": "15", "description": "Pepperoni" }
}
]
?() -> [{
"name": "Acme Store",
"total": 1000000,
"topItem":
{ "price": "50", "description": "Anvil" }
}]
() -> [
{
"Name": "Pizza Planet",
"total": 80000,
"topItem":
{ "price": "15", "description": "Pepperoni" }
}
] API im Knoten Javascript
Das folgende Beispiel ist eine Basisvorlage, der Sie bei der Formatierung Ihrer Ereignis folgen können.
Achtung: ! Das Einrichten eines JSON-Ereignisses erfordert fortgeschrittene Programmierkenntnisse. Unser Support-Team hilft zwar gerne bei den Grundlagen, Informationen in die Ereignis einzubringen, aber wir können keine Unterstützung in Bezug auf die Programmieraspekte leisten. Sie können immer versuchen, unsere Community mit dedizierten Benutzern statt dessen.
var request = required('Request-Promise');
var surveyId = "SV_XXXXXXXXXXXX";
var triggerId = "OC_XXXXXXXXX";
var brandId = "YOUR_BRAND_ID";
var userId = "UR_XXXXXXXXXXXXXXX";
var datacenter = "xx1";
var apiToken = "YOUR_QUALTRICS_API_TOKEN";
var url = "https://" + Rechenzentrum + ".qualtrics/inbound-event/v1/Ereignis/JSON/ggers" +
"?contextId=" + surveyId + "&userId=" + userId + "&brandId=" + brandId + "&triggerId=" + triggerId;
var payload = {
"text": "Dies ist etwas Text",
"object": {
"Nummer": 4
},
"array": ["a", "b", "c", "d"]
};
var options = {
url: url,
json: true,
Hauptteil: Payload,
Kopfzeilen: {
"Content-Type": "application/json ", // ERFORDERLICH!!!
"X-API-TOKEN": apiToken
}
};
request.post(options).then(function (ret) {
console.log("Success:", url, Payload);
}).atch(function (err) {
console.log("error: ", url);
console.log(err);
}); Beispiel: Integration mit Freshdesk
Tipp: Dies ist getrennt von der Aufgabe.
Das JSON Ereignis kann zur Integration mit Freshdesk als Webhook-Regel im Dispatch’r verwendet werden. Das bedeutet, dass Ereignisse in Freshdesk dann Aufgaben in Qualtrics Auslöser können, z. B. die Erstellung eines Ticket oder die Verteilung einer Umfrage.
TIPP: Qualtrics Support kann Ihnen bei der Einrichtung Ihres JSON Ereignisses helfen und es über Freshdesk verbinden. Es kann jedoch einige Fragen zu Freshdesk-Funktionen geben, die sie nicht beantworten können. Wenn Sie Fragen zur Freshdesk-Seite haben, schauen Sie sich die Dokumentation zu Versandregeln.
Tipp: Weitere Informationen zu Freshdesk’s Webhooksfinden Sie in der verlinkten Dokumentation auf ihrer Support-Seite.
Beispiel: Integration mit ServiceNow
Tipp: Dies ist getrennt von der Aufgabe.
Das JSON Ereignis kann für die Integration mit ServiceNow verwendet werden. Das bedeutet, dass Ereignisse in ServiceNow dann Aufgaben in Qualtrics Auslöser können, z.B. die Erstellung eines Ticket oder die Verteilung einer Umfrage.
TIPP: Der Qualtrics Support kann Ihnen bei der Einrichtung Ihres JSON Ereignisses helfen und es über ServiceNow verbinden. Es kann jedoch einige Fragen zu ServiceNow-Funktionen geben, die sie nicht beantworten können. Wenn Sie Fragen zum Anmelden an und Aktivieren Ihrer ServiceNow-Entwicklerinstanz haben, lesen Sie die Dokumentation zu Persönliche Entwicklerinstanzen.
Beispiel: Integration mit Microsoft Dynamics über Microsoft Flow
Tipp: Dies ist getrennt von der Microsoft Aufgabe.
Das JSON-Ereignis sorgt dafür, dass Ereignisse in Microsoft Dynamics Aufgaben in Qualtrics auslösen können, z. B. die Erstellung eines Tickets oder die Verteilung einer Umfrage. Wenn Sie beispielsweise einen Benutzerkonto-Datensatz in Microsoft löschen, können Sie eine Qualtrics-Umfrage an den Besitzer des Benutzerkontos verteilen, in der Fragen zum Ausstieg gestellt werden. (z. B. “Wir bedauern, dass Sie gehen! Wie war Ihre Zeit mit uns? Wie können wir uns verbessern?)
Um das JSON-Ereignis mit den in Microsoft Dynamics stattfindenden Ereignissen zu integrieren, müssen Sie die Einrichtung in Microsoft Flow und nicht in Dynamics vornehmen. Keine Sorge – Microsoft Flow wird mit jedem Microsoft Benutzerkonto kostenlos ausgeliefert, sodass Sie sich mit Ihren Dynamics-Informationen bei Flow anmelden können. hier.
TIPP: Der Qualtrics Support kann Ihnen bei der Einrichtung Ihres JSON Ereignisses helfen und es über Microsoft Flow und Microsoft Dynamics verbinden. Es kann jedoch einige Fragen zu Microsoft-Funktionen geben, die sie nicht beantworten können. Wenn Sie Fragen zur Microsoft-Seite haben, schauen Sie sich die Dokumentation für an. Ablauf und ihre ressourcen für Dynamik.
Tipp: Für diese Schritte wird Microsoft Flow bevorzugt, da er weitere Informationen im JSON an Qualtrics senden kann. Wenn Sie dies in Microsoft Dynamics anstelle von Flow einrichten, werden nur Felder an Qualtrics gesendet, die während des Ereignis geändert wurden. Wenn Sie beispielsweise festlegen, dass der Auslöser werden soll und nur das Feld „E-Mail“ geändert wird, werden „Name“ und „Adresse“ nicht an Qualtrics gesendet, auch wenn Sie explizit nach diesen Feldern im Hauptteil fragen. Flow sendet alles, was Sie angefordert haben, an Qualtrics, unabhängig davon, ob dieses Feld im auslösenden Ereignis geändert wurde.
Beispiel: Integration mit Genesys PureCloud
Tipp: Um diese Integration einzurichten, müssen Sie Zugriff auf Genesys Cloud Architect und Genesys Web Service Data Actions haben.
Mithilfe von JSON können Sie eine Integration mit Genesys PureCloud vornehmen, um Kunden nach Abschluss einer Supporttelefon- oder Chat-Interaktion eine Umfrage zu senden.
FAQs
Ermöglicht das JSON-Ereignis die Integration mit _?
Ermöglicht das JSON-Ereignis die Integration mit _?
- Kann so konfiguriert werden, dass ausgehende HTTP-POST-Aufrufe (z.B. Webhooks, kundendefinierte Anwendung) erfolgen.
- Kann sich durch Übergabe eines Header-Tokens authentifizieren
- Setzt den Content-Type-Header auf „application/json“ und formatiert die Request-Bodys als gültige JSON (optional für Ereignisdaten)
Wie viele Ereignisse pro Minute kann ich zu meinem JSON-Ereignis (op_start) machen, bevor ich gedrosselt werde?
Wie viele Ereignisse pro Minute kann ich zu meinem JSON-Ereignis (op_start) machen, bevor ich gedrosselt werde?
Woher weiß ich, ob mein JSON-Ereignis-Workflow fehlschlägt?
Woher weiß ich, ob mein JSON-Ereignis-Workflow fehlschlägt?
Was sind Workflows? / Wo sind Aktionen?
Was sind Workflows? / Wo sind Aktionen?
Im Rahmen dieser Aktualisierung gibt es keine Änderungen an der Workflow-Funktion.
Großartig! Vielen Dank für die Rückmeldung!
Vielen Dank für die Rückmeldung!