Übersicht über die Customer Journey API

Die Customer Journey API ermöglicht es einem Backend, Customer Journeys programmgesteuert zu verwalten: Journey-Definitionen erstellen und bearbeiten, Journeys durch ihren Lebenszyklus bewegen (starten, pausieren, beenden, entwerfen, archivieren), eine laufende Journey von Ihren eigenen Systemen aus auslösen und Statistiken pro Journey abrufen.

Es ist dieselbe API, die der Customer Journey Builder verwendet, und sie wird über REST/JSON durch eine gRPC-Gateway-Bridge bereitgestellt.

Basis-URL

https://journey.pushwoosh.com

Authentifizierung

Jede Anfrage muss einen Authorization-Header mit einem serverseitigen Pushwoosh API-Zugriffstoken enthalten:

Authorization: Api YOUR_API_TOKEN

Methoden

Journeys verwalten

Lebenszyklus: POST /api/v3/journeygateway/{action}. Eine Journey anhand ihrer UUID starten, pausieren, beenden, entwerfen oder archivieren.
Erstellen und Aktualisieren: POST /api/v3/journeygateway und PUT /api/v3/journeygateway/{uuid}. Eine neue Journey-Definition erstellen oder eine bestehende ersetzen.

Journeys auslösen

Start über API: POST /api/journey/{id}/start/external. Benutzer in den API-Einstiegspunkt einer bereits laufenden Journey einschleusen.

Statistiken und Zielgruppe

Journey-Statistiken abrufen: GET /api/journey/{id}/statistics/external. Zustellungs- und Konversionsmetriken pro Punkt.
Benutzer aus Journeys entfernen: POST /api/journey/drop-users/external. Benutzer aus allen oder ausgewählten aktiven Journeys entfernen.

Referenz

Journey-Objekt: die Form der Journey-Definition (Info, Parameter, Punkte, Kommentare), die von den Lebenszyklus-, Erstellungs- und Aktualisierungsmethoden zurückgegeben wird.
Punkt-Referenz: die point_data-Struktur für jeden Punkttyp: Einstiegs-, Zeit-, Aufteilungs-, Aktions- und Nachrichtenelemente.

Lebenszyklus-Start vs. Start über API

Customer Journey hat zwei Operationen, die ähnlich klingen, sich aber unterschiedlich verhalten.

Lebenszyklus-Start ändert den Journey-Status (zum Beispiel von Entwurf zu Wird ausgeführt). Start über API schleust Benutzer in eine bereits laufende Journey ein. Die folgende Tabelle vergleicht sie nebeneinander.

	Lebenszyklus-Start	Start über API
Endpunkt	`POST /api/v3/journeygateway/start`	`POST /api/journey/{id}/start/external`
Was es tut	Aktiviert die Journey und versetzt sie in den Status Wird ausgeführt	Schleust Benutzer in den API-Einstiegspunkt einer bereits laufenden Journey ein
Erforderlicher Journey-Status	Entwurf oder Pausiert	Wird ausgeführt (mit einem API-Startpunkt)
Ausführungshäufigkeit	Einmal pro Statusänderung	Wiederholt, wenn Benutzer eintreten müssen

Anfrage- und Antwortformat

Inhaltstyp: application/json.
Die v3-Feldnamen verwenden snake_case. Enum-Werte werden als ihre String-Namen serialisiert (zum Beispiel "STATUS_RUNNING", "POINT_TYPE_SEND_PUSH").
Die gRPC-Gateway-Methoden (/api/v3/journeygateway/...) geben bei Erfolg das Journey-Objekt zurück und bei einem Fehler die standardmäßige gRPC-Gateway-Fehlerhülle: { "code": ..., "message": ..., "details": [...] }.
Die älteren externen Methoden (/api/journey/...) geben bei Erfolg einen methodenspezifischen JSON-Body zurück und { "success": false, "message": ... } mit HTTP 400 bei Validierungsfehlern.

Schnellstart

curl -X POST https://journey.pushwoosh.com/api/v3/journeygateway/start \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'

Nächste Schritte

Lebenszyklus

Erstellen und Aktualisieren

Start über API

Journey-Statistiken abrufen

Benutzer aus Journeys entfernen

Journey-Objekt

Punkt-Referenz