Documentation

Braze

Suggest Edits

📘

Why do teams who use Braze report huge increases in their productivity and KPIs when they add Aampe to their MarTech stack?

Read here to learn more.

👍

Estimated setup time

30 minutes

Connection Requirements

  • An API Key for your app group.
  • The Braze dashboard URL that you use (dashboard-01 to 08 or dashboard-01.braze.eu)

Aampe will essentially call the Braze API for sending messages
on your behalf.

Create an API key

  1. Braze dashboard from Settings > API Keys**
  2. On this page you will find the Rest API Keys table

  1. Click on + Create New API Key
  2. Choose a name for your new key, such as aampe-personalisation
  3. Tick the checkboxes to add following permissions
Braze PermissionBraze REST API endpointAampe usage
messages.sendPOST /messages/sendTrigger an API Campaign in Braze.
campaigns.trigger.sendPOST /campaigns/trigger/sendTrigger a send for a campaign that is configured for API-triggered delivery.
campaigns.trigger.schedule.create/campaigns/trigger/schedule/createTrigger a send for a campaign that is configured for scheduled API-triggered delivery.
campaigns.listGET /campaigns/listRetrieve the list of all the campaigns configured in Braze and their associated metadata.
canvas.data_seriesGET /campaigns/data_seriesRetrieve the analytics data of a specific Braze campaign.
campaigns.detailsGET /campaigns/detailsRetrieve the details of a specific Braze campaign.
segments.listGET /segments/listRetrieve the list of all the segments configured in Braze and their associated metadata.
segments.data_seriesGET /segments/data_seriesRetrieve the size of the Braze segment.
segments.detailsGET /segments/detailsRetrieve the details of a specific Braze segment.
templates.infoGET /templates/email/infoRetrieve the details of a specific Braze HTML email template.
templates.listGET /templates/email/listRetrieve the list of all the Braze HTML email templates configured in Braze and their subject line and HTML content.

  1. Finalize the key creation.
  2. You can then view the newly created key by clicking on the gear icon at the right
  3. Copy the API key value.
  4. Login into the Aampe composer using your Aampe credentials.
    Enter `System setup -> Integrations -> Braze . Activate Braze

Enter the API key and dashboard URL copied from the earlier steps. Your connection is now ready to deliver messages

API Campaign Setup

Setting up an API Campaign in Braze allows you to send transactional messages by generating a campaign_id for use in your API calls. This process involves creating the campaign in the Braze dashboard and then using the campaign_id in your API requests to send messages. Here's a step-by-step guide to setting up an API Campaign:

Access the Braze Dashboard:

  1. Log in to your Braze account. Navigate to the Messaging section and select Campaigns.

  2. Create a New Campaign: Click on Create Campaign.Choose API Campaigns as the campaign type.

  3. Configure the Campaign: Name the Campaign: Provide a descriptive title to easily identify the campaign later.

    • Add Message: Click on Add Message Select the message types (channels) you intend to use (e.g., Email, SMS, Push Notifications). This action will generate a campaign_id and a message variation ID for each channel.

  4. Optional - Add Conversion Events: If you wish to track specific user actions as conversions, you can add a conversion event to the campaign.

  5. Save the Campaign: After configuring the necessary settings, click on Save Campaign.

  6. Implement the API Campaign: Retrieve the campaign_id: After saving, note the campaign_id generated for your campaign.

    • Prepare Your API Request:
      • In your API request, include the campaign_id in the appropriate field as specified in Braze's Send Messages Endpoints documentation.
      • For each platform included in the campaign, provide the corresponding message variation ID within the message object.

You are all set with Braze!

Updated 23 days ago