Braze Campaigns icon

Braze Campaigns

Manage and trigger Braze campaigns

Actions6

Trigger

AI-generated

Overview

This node integrates with the Braze platform to manage and trigger marketing campaigns. Specifically, the Trigger operation allows users to send an API-triggered campaign immediately to a targeted audience or broadcast it to an entire segment. This is useful for real-time marketing actions such as sending personalized messages, notifications, or promotions based on external events or workflows.

Practical examples include:

  • Sending a promotional campaign to a specific list of users identified by their external user IDs.
  • Broadcasting a campaign message to all users within a predefined segment.
  • Personalizing campaign messages using dynamic properties passed as JSON key-value pairs.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to be triggered (API campaign ID).
Send ID Optional identifier for this send instance, used for tracking purposes.
Broadcast Boolean flag indicating whether to send the campaign to the entire segment defined in the campaign. Must be true if no recipients or audience are specified.
External User IDs Comma-separated list of external user IDs to receive the campaign (up to 50 users). Ignored if Broadcast is true.
Segment ID Identifier of the segment to target for the campaign. Ignored if Broadcast is true.
Trigger Properties JSON object containing key-value pairs for personalizing the campaign message content.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output JSON contains the response from the Braze API for the triggered campaign request. This typically includes confirmation details about the triggered campaign send.

No binary data is produced by this operation.

Example output JSON structure (simplified):

{
  "json": {
    "message": "Campaign triggered successfully",
    "campaign_id": "example_campaign_id",
    "send_id": "optional_send_id"
  }
}

If an error occurs and "Continue On Fail" is enabled, the output JSON will contain error details including HTTP status code and Braze-specific error codes.

Dependencies

  • Requires an API key credential for authenticating with the Braze REST API.
  • The node uses the Braze instance endpoint configured via credentials.
  • Network access to Braze's API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Campaign ID will cause the API call to fail.
    • Providing both broadcast as false and omitting both externalUserIds and segmentId will result in no recipients being specified, causing errors.
    • Exceeding the limit of 50 external user IDs may cause the request to be rejected.
    • Incorrectly formatted JSON in triggerProperties can lead to request failures.

  • Error messages:

    • Errors returned from Braze API are captured and surfaced in the node output.
    • Typical errors include authorization failures (invalid API key), invalid campaign identifiers, or malformed request bodies.
    • To resolve, verify API credentials, ensure campaign IDs exist and are correct, and validate JSON formatting.

Links and References

Discussion