API-getriggerte Canvases planen
Verwenden Sie diesen Endpunkt, um Canvas-Nachrichten über eine API-getriggerte Zustellung zu planen. Dabei können Sie festlegen, welche Aktion den Versand der Nachricht triggern soll.
Sie können context übergeben, das als Template in die Nachrichten eingefügt wird, die von den ersten Schritten des Canvas gesendet werden.
Die Terminologie und der Liquid-Namespace, die Sie sehen, hängen von den in Ihrem Workspace verfügbaren Features ab:
- Wenn das Dashboard Kontextvariablen anzeigt, referenzieren Sie Entry-Eigenschaften mit
context, z. B.{{context.${property_name}}}. Sie können Variablen auch mit einem Kontext-Schritt erstellen oder aktualisieren. - Wenn das Dashboard Canvas-Entry-Eigenschaften anzeigt, referenzieren Sie diese mit
canvas_entry_properties, z. B.{{canvas_entry_properties.${property_name}}}. Der Kontext-Schritt und der Filter Kontextvariable sind nicht verfügbar.
Weitere Informationen finden Sie unter Kontext und Kontext- und Event-Eigenschaften. Wenn Sie Zugriff auf Canvas-Kontext benötigen, wenden Sie sich an Ihren Customer-Success-Manager.
Beachten Sie, dass Sie zum Versenden von Nachrichten über diesen Endpunkt eine Canvas-ID benötigen, die beim Erstellen eines Canvas generiert wird.
Canvas-Eintritte werden zum geplanten Versandzeitpunkt der Nachricht erfasst, nicht zum Zeitpunkt dieser API-Anfrage. Nutzer:innen, die für einen Zeitplan in der Zukunft getriggert werden, erscheinen erst als Eintritte, wenn der geplante Zeitpunkt erreicht ist.
Sie können das OpenAPI-Dokument herunterladen und damit Schemas validieren. Wie das funktioniert, erfahren Sie unter OpenAPI-Schemas für die Validierung von Anfragen verwenden.