Resumen de la API de Customer Journey

La API de Customer Journey permite a un backend gestionar Customer Journeys programáticamente: crear y editar definiciones de journeys, mover los journeys a través de su ciclo de vida (iniciar, pausar, finalizar, borrador, archivar), activar un journey en ejecución desde sus propios sistemas y extraer estadísticas por journey.

Es la misma API que utiliza el constructor de Customer Journey, expuesta sobre REST/JSON a través de un puente gRPC-Gateway.

URL base

https://journey.pushwoosh.com

Autenticación

Cada solicitud debe incluir un encabezado Authorization con un token de acceso a la API de Pushwoosh del lado del servidor:

Authorization: Api YOUR_API_TOKEN

Métodos

Gestionar journeys

Ciclo de vida: POST /api/v3/journeygateway/{action}. Inicie, pause, finalice, ponga en borrador o archive un journey por su UUID.
Crear y actualizar: POST /api/v3/journeygateway y PUT /api/v3/journeygateway/{uuid}. Cree una nueva definición de journey o reemplace una existente.

Activar journeys

Iniciar por API: POST /api/journey/{id}/start/external. Inyecte usuarios en el punto de entrada de la API de un journey que ya está en ejecución.

Estadísticas y audiencia

Obtener estadísticas del Journey: GET /api/journey/{id}/statistics/external. Métricas de entrega y conversión por punto.
Eliminar usuarios de journeys: POST /api/journey/drop-users/external. Elimine usuarios de todos los journeys activos o de algunos seleccionados.

Referencia

Objeto Journey: la forma de la definición del journey (info, params, points, comments) devuelta por los métodos de ciclo de vida, creación y actualización.
Referencia de punto: la estructura point_data para cada tipo de punto: elementos de entrada, tiempo, división, acción y mensajería.

Inicio del ciclo de vida vs. Iniciar por API

Customer Journey tiene dos operaciones que suenan similares pero se comportan de manera diferente.

El inicio del ciclo de vida cambia el estado del journey (por ejemplo, de Borrador a En ejecución). Iniciar por API inyecta usuarios en un journey que ya está en ejecución. La siguiente tabla los compara.

	Inicio del ciclo de vida	Iniciar por API
Endpoint	`POST /api/v3/journeygateway/start`	`POST /api/journey/{id}/start/external`
Qué hace	Activa el journey y lo mueve al estado En ejecución	Inyecta usuarios en el punto de entrada de la API de un journey que ya está en ejecución
Estado del journey requerido	Borrador o Pausado	En ejecución (con un punto de Inicio de API)
Frecuencia de ejecución	Una vez por cambio de estado	Repetidamente, a medida que los usuarios necesitan entrar

Formato de solicitud y respuesta

Tipo de contenido: application/json.
Los nombres de campo de v3 usan snake_case. Los valores de Enum se serializan como sus nombres de cadena (por ejemplo, "STATUS_RUNNING", "POINT_TYPE_SEND_PUSH").
Los métodos de gRPC-Gateway (/api/v3/journeygateway/...) devuelven el objeto journey si tienen éxito y el sobre de error estándar de gRPC-Gateway si fallan: { "code": ..., "message": ..., "details": [...] }.
Los métodos externos heredados (/api/journey/...) devuelven un cuerpo JSON específico del método si tienen éxito y { "success": false, "message": ... } con HTTP 400 en errores de validación.

Inicio rápido

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

Próximos pasos

Ciclo de vida

Crear y actualizar

Iniciar por API

Obtener estadísticas del Journey

Eliminar usuarios de journeys

Objeto Journey

Referencia de punto