​
Requirements

Note: App Id setup is required only for email channel. Aampe will essentially call the Braze API for sending messages on your behalf.

​
Create an API Key

  1. From the Braze dashboard go to Settings > API Keys
  2. On this page you will find the Rest API Keys table
  3. Click on + Create New API Key
  4. Choose a name for your new key, such as aampe-personalisation
  5. Tick the checkboxes to add following permissions:
Braze PermissionBraze REST API endpointAampe usage
users.export.idsGET /users/export/segment<br/>POST/users/export/global_control_group<br/>POST /sends/id/create<br/>POST /messages/send<br/>POST /campaigns/trigger/send<br/>POST /campaigns/trigger/schedule/create<br/>GET /campaigns/list<br/>GET /campaigns/data_series<br/>GET /campaigns/details<br/>GET /segments/list<br/>GET /segments/data_series<br/>GET /segments/details<br/>GET /email/hard_bounce<br/>GET /templates/email/info<br/>GET /templates/email/list<br/>GET /subscription/user/status<br/>GET/ subscription.groups.get
  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.
  5. Enter System setup -> Integrations -> Braze. Activate Braze
  6. Enter the API key and dashboard URL copied from the earlier steps. Your connection is now ready to deliver messages

​
App Id Setup

  1. To find your app_id go to your Braze account and navigate to Settings > API and Identifiers > App Identifiers
  2. Copy your app_id and navigate back to Aampe Braze integration page select the email channel and add your app_id
📘 Note: App Id is not required if you do not intend to use the email channel through Braze.

​
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.

​
Configure the Campaign:

  1. Name the Campaign: Provide a descriptive title to easily identify the campaign later.
  2. 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.
  3. Optional - Add Conversion Events: If you wish to track specific user actions as conversions, you can add a conversion event to the campaign.

​
In the Campaign Limits:

  • User re-eligible for messages: Check this box and select 0 minutes as we would like aampe agents to be re-eligible based on user’s best time.
  • Select Don’t Count this towards intelligent Frequency limits as we don’t want Aampe to be affected by Braze limits

​
Save the Campaign:

  1. After configuring the necessary settings, click on Save Campaign.

​
Implement the API Campaign:

  1. Retrieve the campaign_id: After saving, note the campaign_id generated for your campaign.
  2. 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 about 1 month ago