Braze

Braze

This connector reads and writes Braze (customer engagement: campaigns, Canvases, segments, users and messaging) through the Braze REST API with a workspace REST API key: campaign and Canvas lists, details and results, segments, the daily KPIs, custom events, purchases, subscription groups and user profiles; it also records attributes and events and can trigger API campaigns and Canvases.

Setup (about 5 minutes)

1. In Braze open Settings, APIs and Identifiers, API Keys and click Create API Key. Keys belong to one workspace.
2. Give it a name and tick the permissions the tools need. For reading: campaigns.list, campaigns.details, campaigns.data_series, sends.data_series, canvas.list, canvas.details, canvas.data_summary, segments.list, segments.details, segments.data_series, kpi.dau.data_series, kpi.mau.data_series, kpi.new_users.data_series, kpi.uninstalls.data_series, events.list, events.data_series, purchases.product_list, purchases.quantity_series, purchases.revenue_series, subscription.status.get, subscription.groups.get, users.export.ids. For writing add users.track, campaigns.trigger.send and canvas.trigger.send (and users.delete only if the delete tool will be turned on). A key's permissions cannot be changed later: create a new key instead.
3. Copy the key and the REST endpoint shown on the same page and paste them into BRAZE_REST_API_KEY and BRAZE_REST_ENDPOINT. The endpoint depends on your Braze instance: https://rest.iad-01.braze.com, https://rest.iad-02.braze.com, https://rest.iad-03.braze.com, https://rest.iad-04.braze.com, https://rest.iad-05.braze.com, https://rest.iad-06.braze.com, https://rest.iad-07.braze.com, https://rest.iad-08.braze.com and https://rest.us-10.braze.com (US), https://rest.fra-01.braze.eu and https://rest.fra-02.braze.eu (EU), https://rest.au-01.braze.com, https://rest.id-01.braze.com, https://rest.jp-01.braze.com, https://rest.kr-01.braze.com. The dashboard address tells which: dashboard-01.braze.com uses rest.iad-01, dashboard-01.braze.eu uses rest.fra-01, and so on.

The key acts for the whole workspace, not for one person: whoever uses this connector sees what the key can read, including user profiles. Share the MCP server only with people allowed to see that.

Limits: most endpoints allow 250,000 requests an hour. /users/export/ids allows 250 a minute for workspaces onboarded since August 2024 (2,500 before); /events/list and /purchases/product_list share 1,000 an hour; /users/track takes up to 75 objects per call (attributes, events and purchases combined) at a rate set by your contract; the send endpoints allow 250 broadcast calls a minute, 10 a minute per audience. Braze answers 429 when a limit is reached.

How to work

1. Campaigns: braze_list_campaigns for ids, then braze_get_campaign for setup and messages and braze_get_campaign_data_series for daily results. braze_get_send_data_series gives the results of one tracked send of an API campaign.
2. Canvases: braze_list_canvases, braze_get_canvas, then braze_get_canvas_data_summary for entries, conversions and revenue (per variant or step on request).
3. Audience: braze_list_segments, braze_get_segment and braze_get_segment_size_series (segments with analytics tracking).
4. App health: braze_get_kpi_series with metric dau, mau, new_users or uninstalls.
5. Behaviour and revenue: braze_list_custom_events then braze_get_custom_event_series; braze_list_products, braze_get_purchase_quantity_series and braze_get_revenue_series.
6. People: braze_export_users_by_ids reads profiles by external id, alias, braze_id, email or phone (POST, but only reads); braze_get_subscription_group_status and braze_list_user_subscription_groups show subscription states.
7. Writes, each only after the user confirms: braze_track_users records attributes, events and purchases (it can move users into segments and start Canvases). braze_send_campaign and braze_send_canvas send real messages: show what will be sent and to whom first, and for broadcast or more than one recipient wait for an explicit "yes, send".
8. braze_delete_users deletes profiles for good and is installed switched off; an administrator turns it on deliberately.

Series take length in days (1 to 100, Canvas summaries 1 to 14) before ending_at (ISO 8601, default now). Lists come 100 per page starting at page 0.

Common errors

• 401 "Invalid API key": the key is wrong or belongs to another instance; check that the REST endpoint matches your dashboard.
• 403 "Access Denied": the key lacks the permission for this endpoint. Create a key with it.
• 400: a parameter is missing or invalid, e.g. length out of range or an unknown campaign_id; the message names it.
• 429: a rate limit is reached; wait and retry once.

Out of scope here: content blocks and templates, catalogs, email lists and hard bounces, scheduled messages, preference centers, SCIM, user alias and identify endpoints, segment exports to cloud storage and Currents.