Lorsque vous configurez un parcours incluant un appel d'attente pour l'API, vous devez disposer d'un point de terminaison de webhook.
Le point de terminaison reçoit des informations sur les personnes qui entrent dans l'étape d'attente et sur la manière de libérer chaque contact vers les différents chemins de votre parcours.
Vous pouvez ensuite faire avancer un contact dans votre flux lorsque les événements connectés dans d'autres systèmes sont terminés.
L'étape d'attente de l'appel API fournit toujours trois chemins : accepté, rejeté et délai d'attente. Chaque contact qui entre dans l'attente reçoit une demande unique d'acceptation (conduit au chemin A) et une demande unique de rejet (conduit au chemin B). Si aucune de ces demandes n'est appelée dans le délai fixé par le délai d'attente, le contact entrera dans le chemin du délai d'attente (chemin C).
Mise en place
Allez dans Paramètres du compte > (Intégrations) Webhook Attente parcours. Dans la liste déroulante, sélectionnez si vous souhaitez modifier au niveau du compte ou pour un projet spécifique.
- Point de terminaison du webhook (Webhook uri) : L'URL où vous souhaitez recevoir le webhook.
- En-tête et valeur personnalisés (Custom header et Custom header value) : Entrez un en-tête et une valeur d'en-tête facultatifs.
- Utilisateur et mot de passe d'authentification de base : si votre terminal est sécurisé par une authentification de base, vous devez entrer les informations d'identification ici.
Tous les paramètres enregistrés dans un projet remplaceront tous les paramètres au niveau du compte.
Par exemple, si vous configurez un parcours dans un projet où aucun point de terminaison n'a été enregistré, le point de terminaison enregistré au niveau du compte sera utilisé. Mais si vous avez ajouté un en-tête de webhook au projet, celui-ci remplacera l'en-tête de webhook au niveau du compte.
Si vous souhaitez utiliser les mêmes paramètres pour tous vos déplacements, il vous suffit d'enregistrer vos paramètres au niveau du compte.
Informations webhook
Le webhook comprendra les détails suivants :
ContactId : L'identifiant original du contact
CarmaContactId : Le ID de l'utilisateur final Symplify
ListId : La liste du parcours et du contact
JourneyId : L'ID du parcours où le contact attend
JourneyVersions : La version du parcours où le contact est en attente
JourneyStep : L'identification de l'étape d'attente
Identifiants : L'identifiant de l'étape d'attente que vous avez fourni
AgentActionName : Le nom de l'agent tiers qui gère les événements (le cas échéant)
AcceptrUri : l'URI unique permettant de libérer le contact spécifique pour continuer votre flux principal (voie A)
RejectUri : l'URI unique permettant de rejeter le contact spécifique pour continuer votre flux principal et entrer plutôt dans le chemin B.
Champs personnalisés : Informations personnalisées fournies dans l'étape "Attendre".