Déclencheur REST

👨‍💻️ Qu'est-ce qu'un déclencheur REST ?

Le point de terminaison API REST trigger de campagne vous permet d'ajouter de nouveaux destinataires à n'importe laquelle de vos campagnes à la volée en utilisant un simple POST HTTP vers l'API trigger.

En utilisant le point de terminaison API REST trigger, vous pouvez facilement intégrer et automatiser le système de campagnes d'ngSurvey avec n'importe quel système tiers qui doit envoyer des invitations de Sondage à la volée. Par exemple, vous pourriez connecter ngSurvey à un système de ticketing qui enverrait des invitations à un Sondage de satisfaction à la fermeture d'un ticket.

📨 Configuration du trigger

Pour configurer votre trigger, vous devez créer une campagne en cours d'exécution ; une fois cette campagne configurée, vous pourrez accéder au lien du trigger via l'écran REST trigger.

Vous y trouverez le lien HTTP du trigger que vous pouvez utiliser pour mettre en file d'attente de nouveaux destinataires dans votre campagne. L'écran de trigger de campagne vous permet également de modifier le message par défaut qui sera utilisé comme modèle d'invitation pour tous les destinataires mis en file d'attente via le trigger.

🚀 Comment utiliser le REST trigger

Le endpoint API requiert un POST HTTP accompagné d'un en-tête Authorization contenant votre API key comme valeur précédée du préfixe Bearer.

Le corps de votre POST HTTP doit être défini en utilisant la structure JSON suivante

{
  "recipients": string[],
  "anonymous": boolean,
  "clearExistingBatches": boolean,
  "daysThreshold": number,
  "pipeParameters": { string:string },
  "mailingTemplateId": string,
  "message": {
    "mailingFrom": string,
    "mailingFromName": string
    "mailingSubject": string
    "mailingMessage": string
 }
}

🔅 Propriétés de l'API Trigger

• recipients Est la liste des destinataires qui sont ajoutés au lot de la campagne. Utilisez des e-mails si votre campagne est basée sur des e-mails, des téléphones si elle est basée sur des SMS et utilisez des Identifiants de Panéliste si vous avez une campagne basée sur un panel.

• anonymous ne liera pas l'email du Répondant aux réponses du Répondant et supprimera l'email de la base de données une fois que le Répondant aura répondu au Sondage. Cette option n'est valide que si vous utilisez le trigger sur une campagne basée sur les e-mails.

• clearExistingBatches supprimera du lot d'envoi toute entrée précédente du destinataire. Notez qu'il ne supprimera que l'entrée du lot d'envoi et n'effacera aucune réponse au Sondage.

• daysThreshold Optionnel. Correspond au nombre de jours après lequel un destinataire peut être ajouté à nouveau au lot d'envoi. Laissez ceci à null pour que vos destinataires puissent être ajoutés au lot d'envoi à tout moment. Vous pouvez également définir sa valeur à 0 pour n'ajouter le destinataire que s'il n'y a aucune entrée précédente dans le lot d'envoi.

• pipeParameters Optionnel. Vous permet de définir des paramètres dynamiques nom/valeur qui seront remplacés dans le message d'invitation.

• mailingTemplateId Optionnel. Vous permet d'utiliser un modèle de mailing existant comme message d'invitation.

• message Optionnel. Vous permet de remplacer le message d'invitation par défaut du trigger par votre propre message. Notez que cela remplacera également la propriété mailingTemplateId.

Si vous utilisez le piping, des mailing templates ou un message personnalisé pour votre trigger, veuillez noter que ngSurvey créera une nouvelle entrée de message d'invitation dans la base de données pour chaque destinataire. En conséquence, nous recommandons de régler clearExistingBatches sur true si vous exécutez une automatisation avec un grand nombre d'appels au trigger incluant les mêmes destinataires au fil du temps.

Si vous exécutez une automatisation avec un grand nombre d'appels au trigger incluant des destinataires récurrents, nous recommandons de définir la propriété clearExistingBatches afin de conserver une seule entrée d'envoi de lot pour chaque destinataire dans la base de données ngSurvey.

🚰 Valeurs de piping

en utilisant la propriété optionnelle pipeParameters, vous pouvez spécifier un ensemble de valeurs qui seront pipées à l'exécution dans le message d'invitation envoyé aux destinataires. Les balises de pipe dans votre message d'invitation doivent être formatées comme suit : [*propertyname*]

  "pipeParameters": {
    "prop1": "value1",
    "prop2": "value2",
    "prop3": "value3"
  }

Pour pipetter la valeur prop1 dans votre message d'invitation, vous devrez ajouter la balise suivante qui sera remplacée par value1 à l'exécution.

[*prop1*]

Si vous déclenchez l'invitation depuis un système de ticketing, vous pourriez par exemple pipetter le numéro du ticket dans le lien du Sondage de votre message d'invitation et stocker ce ticket dans un champ caché du Sondage.

Exemple CURL / Body

curl -X POST "http://yoursite/api/Campaigns/yourcampaign/trigger" -H  "accept: */*" -H  "Authorization: Bearer YOURAPIKEY" -H  "Content-Type: application/json-patch+json" -d "{\"recipients\":[\"[email protected]\",\"[email protected]\"],\"anonymous\":false,\"clearExistingBatches\":false,\"daysThreshold\":null,\"pipeParameters\":{\"prop1\":\"value1\",\"prop2\":\"value2\",\"prop3\":\"value3\"},\"message\":null,\"mailingTemplateId\":null}"

{
  "recipients": ["[email protected]", "[email protected]"],
  "anonymous": false,
  "clearExistingBatches": false,
  "daysThreshold": null,
  "pipeParameters": {
    "prop1": "value1",
    "prop2": "value2",
    "prop3": "value3"
  },
  "message": null,
  "mailingTemplateId": null
}