Démarrage par API

POST https://journey.pushwoosh.com/api/journey/{id}/start/external

Fait entrer un ensemble d’utilisateurs dans le point d’entrée API d’un Journey. Utilisez-le pour piloter des Journeys depuis votre propre backend. Par exemple, démarrez un flux d’intégration lorsqu’un utilisateur termine son inscription sur votre serveur.

Conseil

Ne confondez pas cet appel avec le démarrage du cycle de vie, qui active un Journey et le fait passer à l’état En cours d’exécution. Le démarrage par API injecte des utilisateurs dans un Journey qui est déjà en cours d’exécution. Consultez le tableau comparatif.

Prérequis

• Le Journey est dans l’état En cours d’exécution.
• Le Journey contient exactement un point d’entrée API (l’élément « Démarrage par API »), et cet élément n’est pas désactivé.
• Les noms d’attributs que vous envoyez correspondent aux attributs configurés sur ce point d’entrée API.

Limite de débit

Chaque point d’entrée API accepte une requête par minute. Une deuxième requête dans cette fenêtre renvoie une erreur (Enhance your calm! only one request per minute is allowed). Regroupez vos destinataires en une seule requête plutôt que d’en envoyer plusieurs petites.

Paramètres de chemin

Nom	Type	Description
id	chaîne	ID du Journey du Journey en cours d’exécution.

En-têtes de requête

Nom	Requis	Valeur
Content-Type	Oui	application/json
Authorization	Oui	Api <server_api_token>. Voir Jeton d’API serveur.

Corps de la requête

Le corps a un seul objet payload. Vous devez fournir exactement un des éléments suivants : users, hwids ou filter pour sélectionner qui entre dans le Journey.

Champ	Type	Description
payload.users	string[]	ID utilisateur à faire entrer. Mutuellement exclusif avec hwids et filter.
payload.hwids	string[]	HWID à faire entrer. Mutuellement exclusif avec users et filter.
payload.filter	string	Une expression seglang sélectionnant l’audience. Mutuellement exclusif avec users et hwids.
payload.attribute_values	map<string, string>	Optionnel. Valeurs pour les attributs personnalisés définis sur le point d’entrée API. Chaque clé doit correspondre à un nom d’attribut configuré.

Exemples de requête

Faire entrer des utilisateurs spécifiques

curl -X POST 'https://journey.pushwoosh.com/api/journey/<journey_id>/start/external' \
  -H 'Authorization: Api YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "payload": {
      "users": ["user-123", "user-456"]
    }
  }'

Faire entrer des utilisateurs spécifiques avec des attributs

{
  "payload": {
    "users": ["user-123", "user-456"],
    "attribute_values": {
      "promo_code": "SUMMER25",
      "tier": "gold"
    }
  }
}

Faire entrer une audience par filtre

{
  "payload": {
    "filter": "A(\"XXXXX-XXXXX\").tags(\"City\").eq(\"London\")"
  }
}

Réponse

200

{
  "request_uuid": "9f8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d"
}

Champ	Type	Description
request_uuid	chaîne	Identifiant de la requête d’entrée acceptée. La requête est traitée de manière asynchrone.

400

Les erreurs de validation renvoient un code HTTP 400 avec un message descriptif. Cas courants :

Message	Cause
one of users, hwids or filter must be provided	Aucun des trois sélecteurs n’a été défini.
only one of users, hwids or filter must be provided	Plus d’un sélecteur a été défini.
Journey is not running	Le Journey n’est pas dans l’état En cours d’exécution.
zero api start points	Le Journey n’a pas de point d’entrée API.
there is more then one api start point	Le Journey a plus d’un point d’entrée API.
point is deactivated	Le point d’entrée API est désactivé.
unknown attribute: <name>	Une clé attribute_values n’est pas configurée sur le point d’entrée API.
Enhance your calm! only one request per minute is allowed	Limite de débit atteinte (une requête par minute par point d’entrée).

Articles connexes

Cycle de vie

Obtenir les statistiques du Journey

Langage de segmentation