Braze Campaigns icon

Braze Campaigns

Manage and trigger Braze campaigns

Actions6

Schedule Trigger

AI-generated

Overview

This node allows you to manage and trigger marketing campaigns via the Braze platform. Specifically, the Schedule Trigger operation lets you schedule an API-triggered campaign for future delivery at a specified time. This is useful when you want to automate sending personalized campaigns to targeted users or segments at precise moments, such as launching a promotion or event notification.

Practical examples include:

  • Scheduling a promotional email campaign to be sent at midnight on a product launch day.
  • Sending a push notification campaign to a specific user segment during their local daytime hours.
  • Automating reminders or follow-ups by scheduling campaigns with custom properties for personalization.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to be scheduled (API identifier from campaign details).
Send ID Optional identifier for tracking this particular send instance.
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 (up to 50) to send the campaign to. Ignored if Broadcast is true.
Segment ID Identifier of the user segment to target for the campaign. Ignored if Broadcast is true.
Trigger Properties JSON object containing key-value pairs used for personalizing the message content dynamically.
Schedule Time ISO 8601 datetime string specifying when the campaign should be sent. This is required.
Send in Local Time Boolean flag indicating whether to send the message according to each recipient's local timezone.
Send at Optimal Time Boolean flag indicating whether to send the message at the optimal engagement time for each user, based on their typical interaction patterns.

Output

The node outputs a JSON object representing the response from the Braze API after scheduling the campaign. This typically includes confirmation details about the scheduled campaign trigger, such as schedule identifiers and status.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "schedule_id": "string",
  "campaign_id": "string",
  "time": "ISO 8601 datetime string",
  "status": "scheduled"
}

Dependencies

  • Requires an API key credential for authenticating with the Braze API.
  • The node uses the Braze API endpoint configured via credentials.
  • Proper permissions on the Braze account to schedule campaigns are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing campaign ID will cause the API request to fail.
    • Providing both broadcast as false and omitting both externalUserIds and segmentId will result in an invalid request.
    • Incorrectly formatted scheduleTime (not ISO 8601) may cause scheduling errors.
    • Exceeding the limit of 50 external user IDs will likely cause rejection.

  • Error messages:

    • Errors returned from the Braze API are captured and presented with their message and HTTP code.
    • If the node is set to continue on failure, error details are included in the output JSON under an error field.
    • Common API error codes relate to authentication failures, invalid parameters, or permission issues.

  • Resolution tips:

    • Verify all required fields are correctly filled.
    • Ensure date/time strings conform to ISO 8601 format.
    • Check API key validity and permissions.
    • Limit the number of external user IDs to 50 or fewer.

Links and References

Discussion