Braze Canvas icon

Braze Canvas

Manage and trigger Braze Canvas campaigns

Actions4

Schedule Canvas

AI-generated

Overview

This node integrates with Braze to manage and trigger Canvas campaigns, which are multi-step messaging campaigns designed for customer engagement. Specifically, the Schedule Canvas operation allows users to schedule a Canvas message to be sent at a future time, optionally targeting specific users or segments, and supports personalization through trigger properties.

Common scenarios where this node is beneficial include:

  • Scheduling marketing campaigns to launch at precise times.
  • Sending personalized messages to targeted user segments.
  • Coordinating campaign delivery according to recipients' local time zones or optimal engagement times.

For example, a marketer can schedule a promotional Canvas to be sent next week at 9 AM in each recipient’s local time zone, ensuring timely and relevant communication.

Properties

Name Meaning
Canvas ID The unique identifier of the Canvas campaign to schedule.
Send ID Optional identifier for the send event, useful for tracking purposes.
Broadcast Boolean flag indicating whether to send the Canvas to the entire segment defined in the Canvas. Must be true if no specific recipients or audience segments are provided.
External User IDs Comma-separated list of external user IDs (up to 50) to receive the Canvas. Ignored if Broadcast is true.
Segment ID Identifier of a user segment to target for the Canvas. Ignored if Broadcast is true.
Trigger Properties JSON object containing key-value pairs used for personalizing the Canvas content dynamically.
Schedule Time ISO 8601 datetime string specifying when the Canvas should be sent. This is required.
Send in Local Time Boolean flag indicating whether to send the Canvas according to each recipient's local time zone.
Send at Optimal Time Boolean flag indicating whether to send the Canvas at the optimal time for each user based on engagement data.

Output

The node outputs a JSON object representing the response from the Braze API after scheduling the Canvas. This typically includes confirmation details about the scheduled campaign.

If an error occurs, the output JSON will contain error information including:

  • error: A descriptive error message.
  • originalError: The original error message from the HTTP request.
  • httpCode: The HTTP status code returned by the Braze API.
  • brazeErrorCode: Specific error code returned by Braze, if available.

No binary data is produced by this node.

Dependencies

  • Requires an active Braze API connection configured with an API key credential.
  • The node uses Braze's REST API endpoints for Canvas management.
  • Proper permissions on the Braze account to schedule Canvas campaigns are necessary.

Troubleshooting

  • Invalid JSON in Trigger Properties: If the triggerProperties input contains malformed JSON, the node will throw an error indicating invalid JSON. Ensure that the JSON string is correctly formatted.
  • Missing Required Fields: The canvasId and scheduleTime fields are mandatory. Omitting these will cause errors.
  • API Authentication Errors: If the API key is invalid or missing, authentication errors will occur. Verify the API key credential configuration.
  • Broadcast vs Recipients Conflict: When broadcast is set to true, do not provide externalUserIds or segmentId. Providing both may cause unexpected behavior or errors.
  • HTTP Errors from Braze: The node surfaces HTTP errors with detailed messages. Check the Braze API documentation for error codes and meanings.

Links and References

Discussion