Planifier des Canvas déclenchés par API
Utilisez cet endpoint pour planifier des messages Canvas via une distribution déclenchée par API, ce qui vous permet de décider quelle action doit déclencher l’envoi du message.
Vous pouvez transmettre un context qui sera intégré dans les messages envoyés par les premières étapes du Canvas.
La terminologie et l’espace de noms Liquid affichés dépendent des fonctionnalités disponibles dans votre espace de travail :
- Si le tableau de bord affiche Context Variables, référencez les propriétés d’entrée avec
context, par exemple{{context.${property_name}}}. Vous pouvez également créer ou mettre à jour des variables avec une étape Context. - Si le tableau de bord affiche Canvas Entry Properties, référencez-les avec
canvas_entry_properties, par exemple{{canvas_entry_properties.${property_name}}}. L’étape Context et le filtre Context Variable ne sont pas disponibles.
Pour en savoir plus, consultez les sections Contexte et Propriétés de contexte et d’événement. Si vous avez besoin d’accéder au contexte Canvas, contactez votre gestionnaire de la satisfaction client.
Notez que pour envoyer des messages avec cet endpoint, vous devez disposer d’un ID Canvas, généré lors de la création d’un Canvas.
Les entrées dans le Canvas sont enregistrées à l’heure planifiée du message, et non au moment où cette requête API est effectuée. Les utilisateurs déclenchés pour une planification à une date future n’apparaîtront dans les entrées qu’une fois l’heure planifiée atteinte.
Vous pouvez télécharger le document OpenAPI et l’utiliser pour valider des schémas. Pour savoir comment procéder, consultez Utiliser les schémas OpenAPI pour la validation des requêtes.