Schedule API-triggered Canvases
Use this endpoint to schedule Canvas messages via API-triggered delivery, allowing you to decide what action should trigger the message to be sent.
You can pass in context that will be templated into the messages sent by the first steps of the Canvas.
The terminology and Liquid namespace you see depend on the features available in your workspace:
- If the dashboard shows Context Variables, reference entry properties with
context, such as{{context.${property_name}}}. You can also create or update variables with a Context step. - If the dashboard shows Canvas Entry Properties, reference them with
canvas_entry_properties, such as{{canvas_entry_properties.${property_name}}}. The Context step and Context Variable filter aren’t available.
For more information, see Context and Context and event properties. If you need access to Canvas Context, contact your customer success manager.
Note that to send messages with this endpoint, you must have a Canvas ID, created when you build a Canvas.
Canvas entries are recorded at the scheduled message time, not when this API request is made. Users triggered for a future-dated schedule won’t appear as entries until that scheduled time arrives.
You can download the OpenAPI document and use it to validate schemas. To learn how, see Use OpenAPI schemas for request validation.