Braze Canvas icon

Braze Canvas

Manage and trigger Braze Canvas campaigns

Actions4

Send Canvas

AI-generated

Overview

The Braze Canvas node allows users to manage and trigger multi-step campaign messages (called Canvases) via the Braze API. It supports sending immediate Canvas messages, scheduling them for future delivery, retrieving analytics data, and fetching detailed information about specific Canvas campaigns.

This node is beneficial in marketing automation workflows where personalized, multi-step messaging campaigns are orchestrated. For example, a marketer can use this node to:

  • Send a targeted Canvas campaign immediately to a segment or specific users.
  • Schedule a Canvas campaign to be sent at an optimal or specified time.
  • Retrieve time-series analytics to measure campaign performance.
  • Get detailed metadata about a Canvas campaign for reporting or auditing.

Properties

Name Meaning
Canvas ID The unique identifier of the Canvas campaign to send, schedule, or query.
Send ID Optional identifier for tracking the specific send instance of the Canvas message.
Broadcast Boolean flag indicating whether to send the Canvas to the entire segment defined in the Canvas. Must be true if no recipients or audience are specified.
External User IDs Comma-separated list of external user IDs (up to 50) to target with the Canvas message.
Segment ID Identifier of a segment to target for the Canvas message.
Trigger Properties JSON object containing key-value pairs used for personalization within the Canvas campaign.

Output

The node outputs JSON data representing the response from the Braze API for the selected operation:

  • For Send Canvas and Schedule Canvas, the output contains confirmation details of the triggered or scheduled Canvas message.
  • For Canvas Analytics, the output includes time-series analytics data related to the Canvas campaign.
  • For Canvas Details, the output provides detailed metadata about the Canvas campaign.

If an error occurs, the output JSON will contain error details including the error message, HTTP status code, and Braze-specific error codes.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Braze API.
  • Needs the Braze API endpoint URL configured based on the instance region.
  • Uses HTTP requests to communicate with Braze's REST API.

Troubleshooting

  • Invalid JSON in Trigger Properties: If the triggerProperties input contains malformed JSON, the node throws an error indicating invalid JSON. Ensure that the JSON string is correctly formatted.
  • Missing Required Parameters: The canvasId is mandatory; omitting it will cause errors.
  • Broadcast Flag Usage: When broadcast is set to true, do not specify externalUserIds or segmentId. Violating this may cause API errors.
  • API Authentication Errors: Invalid or missing API keys will result in authentication failures.
  • Rate Limits or API Errors: The node surfaces Braze API error messages and codes. Review these to adjust request parameters or handle rate limits.

To resolve errors, verify all required inputs, ensure valid JSON formatting, and confirm API credentials and permissions.

Links and References

Discussion