Braze CanvasInstall

Overview

This node integrates with the Braze platform to manage and trigger Canvas campaigns, which are multi-step messaging campaigns. Specifically, the Canvas Details operation retrieves detailed information about a particular Canvas campaign by its identifier. This is useful for users who want to programmatically access metadata and configuration details of their Canvas campaigns within an automation workflow.

Practical examples include:

• Fetching the current state and settings of a Canvas campaign before triggering or scheduling messages.
• Retrieving draft changes for Canvases that have post-launch drafts enabled, allowing review or conditional logic based on draft content.
• Integrating Canvas campaign details into reporting dashboards or audit logs.

Properties

Output

The output is a JSON object containing detailed information about the specified Canvas campaign as returned by the Braze API. This includes all metadata and configuration details relevant to the Canvas.

The node does not output binary data.

Example structure (simplified):

{
  "canvas_id": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "steps": [ /* array of campaign steps */ ],
  "created_at": "timestamp",
  "updated_at": "timestamp",
  // Additional fields depending on Braze API response
}

If the postLaunchDraftVersion property is set to true, the response will include draft changes that are not yet live.

Dependencies

• Requires an API key credential for authenticating with the Braze API.
• Needs the Braze instance URL configured in the credentials.
• The node makes HTTP requests to Braze's REST API endpoints.

Troubleshooting

• Invalid JSON in trigger properties: If using other operations that accept JSON input (not applicable here), ensure JSON strings are well-formed.
• HTTP errors from Braze API: Errors returned by Braze are captured and can include HTTP status codes and Braze-specific error codes. Common issues might be invalid Canvas IDs, insufficient permissions, or expired API keys.
• Missing or incorrect Canvas ID: The Canvas ID is required; omitting it or providing an invalid ID will cause the request to fail.
• Post Launch Draft Version flag misuse: Setting this flag when the Canvas does not support post-launch drafts may result in unexpected responses or errors.

To resolve errors:

• Verify the Canvas ID exists and is correct.
• Check API key validity and permissions.
• Review Braze API documentation for error code meanings.

Links and References

• Braze Canvas API Documentation
• Braze Developer Portal