APIトリガーキャンバスのスケジュール
このエンドポイントを使用して、APIトリガー配信でキャンバスメッセージをスケジュールします。これにより、どのアクションでメッセージの送信をトリガーするかを決めることができます。
キャンバスの最初のステップで送信されるメッセージにテンプレート化される context を渡すことができます。
表示される用語とLiquidの名前空間は、ワークスペースで利用可能な機能によって異なります。
- ダッシュボードにコンテキスト変数と表示される場合は、エントリプロパティを
contextで参照します（例：{{context.${property_name}}}）。コンテキストステップを使用して変数を作成または更新することもできます。 - ダッシュボードにキャンバスエントリプロパティと表示される場合は、
canvas_entry_propertiesで参照します（例：{{canvas_entry_properties.${property_name}}}）。コンテキストステップおよびコンテキスト変数フィルターは利用できません。
詳細については、コンテキストおよびコンテキストとイベントプロパティを参照してください。キャンバスコンテキストへのアクセスが必要な場合は、カスタマーサクセスマネージャーにお問い合わせください。
このエンドポイントを使用してメッセージを送信するには、キャンバスの構築時に作成されるキャンバスIDが必要です。
キャンバスのエントリは、このAPIリクエストが行われた時点ではなく、スケジュールされたメッセージの送信時刻に記録されます。将来の日時のスケジュールでトリガーされたユーザーは、そのスケジュール時刻が到来するまでエントリとして表示されません。
Endpoint reference
This reference is generated from the OpenAPI specification for this endpoint. To run the endpoint, copy the generated cURL example and send it from your terminal or Postman. You can also download the raw OpenAPI spec for this page at /docs/ja/assets/api/openapi/messaging_schedule_messages_post_schedule_triggered_canvases.yaml. Use this spec to validate that your requests include the correct parameters, fields, and structure before you send them. To learn how, see Use OpenAPI schemas for request validation.