# Braze setup for PopMCP You paste one Braze REST API key, made in your workspace under Settings, APIs and Identifiers. It works for that one workspace, holds only the permissions you tick, and PopMCP finds your Braze instance for you. You need a Braze customer account. - Auth: API credentials - Setup time: 3 min - API base URL: One per instance, such as https://rest.iad-01.braze.com (US-01) or https://rest.fra-01.braze.eu (EU-01). PopMCP finds yours. - Credentials screen: https://www.braze.com/docs/api/basics#creating-rest-api-keys - Provider docs: https://www.braze.com/docs/api/basics ## Approval required before this works You need to be a Braze customer. Braze has no free plan, and access comes through its sales team, which also offers trials, startup programs and other entry plans. With an account, Braze reviews nothing: you can make a REST API key yourself. - Typical wait: None if your company already uses Braze and you can open Settings, APIs and Identifiers. Otherwise it is a sales conversation with Braze. - Cost: Set in your contract with Braze, and it scales with Monthly Active Users. On contracts priced by data points, each attribute written through the API uses one. - Blocked until approved: Without a Braze workspace there is nowhere to make a key. Some features are extras on the contract, such as Transactional Email, and those tools are refused until Braze turns the feature on. - Works meanwhile: If your company has Braze, ask a teammate who can open Settings, APIs and Identifiers to make the key with the permissions you need. ## Before you begin - A Braze customer account. Braze has no free plan, and access comes through its sales team. - A Braze role that lets you open Settings, APIs and Identifiers in the workspace you want to connect. If you can't see it, ask a teammate who can to make the key. - A few features need Braze to turn them on first: Transactional Email, data objects (Accounts), and the limited betas of users track bulk and sync. Everything else works straight away. ## Get your credentials ### 1. Open APIs and Identifiers Sign in to the Braze dashboard, using the address you normally use, and switch to the workspace you want to connect. Open Settings, then APIs and Identifiers, and stay on the API Keys tab. A key belongs to one workspace, so check the workspace name first. ### 2. Create a key and tick its permissions Choose Create API Key and name it something you will recognise, like `PopMCP`. Tick every permission you want the AI to use, because Braze keys can't be edited later: adding one means making a new key and reconnecting. For reports only, tick the list, details and data series permissions for campaigns, Canvases and segments, plus `events.list` and the `kpi` ones. To update users, add `users.track` and `users.export.ids`. To send, add `messages.send`, `campaigns.trigger.send` and `canvas.trigger.send`. Leave the IP allowlist empty, or PopMCP's calls will be refused. ### 3. Copy the Identifier Back on the API Keys tab, find your new key. The value in the Identifier column is the REST API key. Copy it. Don't use the app identifiers or SDK keys on the same page: those won't connect. ### 4. Paste the key into PopMCP Paste it into Braze REST API key. PopMCP tries the key on Braze's instances, remembers where it works, and tells you what it could read. Under More options, you can add a Workspace name, which is how the connection is labelled, since Braze's API doesn't share workspace names. Connecting fails only if Braze refuses the key everywhere. If you're sure the key is right, enter your dashboard address there too. ## Fields PopMCP asks for - Braze REST API key (apiKey) [required]: From Settings > APIs and Identifiers > API Keys in Braze. The Identifier shown there is the key. Use a REST API key, not an SDK key. Stored encrypted, used server-side only. - Braze dashboard address (optional) (instance): We find this for you. Fill it in only if connecting fails, with the address you use for Braze or its instance name: US-01, US-02, US-03, US-04, US-05, US-06, US-07, US-08, US-10, EU-01, EU-02, AU-01, ID-01, JP-01, KR-01. - Workspace name (optional) (workspaceName): What to call this workspace in PopMCP. Braze does not share workspace names with its API. - SCIM token (optional) (scimToken): Only for tools that manage your team's Braze dashboard users. From Settings > Admin Settings > SCIM Provisioning. - SCIM service origin (optional) (scimOrigin): The service origin you set beside the SCIM token. ## Verify PopMCP shows Braze as Verified, labelled with your workspace name or Braze workspace, and the instance such as US-01. Ask for a map of your workspace: braze_get_workspace_overview answers with your newest campaigns, Canvases and segments, and names any permission the key lacks. ## Troubleshooting ### "Braze did not accept this key on any of its instances" Cause: The key was copied incompletely, is an SDK key, has allowed IP addresses set, or holds none of the permissions PopMCP reads first. Fix: Copy the Identifier again. If it still fails, make a new REST API key with `campaigns.list` ticked and the IP allowlist empty. ### "We don't recognise that Braze address" Cause: PopMCP only accepts Braze's own dashboard addresses and instance names. Fix: Copy the address from your browser while signed in to Braze, such as `dashboard-01.braze.com`, use a name like `US-01`, or leave the field empty. ### A tool answers that the key may not have a permission Cause: Keys hold only what was ticked when they were made, and a key made before a feature launched doesn't get it automatically. Fix: Make a new key with that permission ticked, then reconnect Braze in PopMCP. ### A tool answers 429, or says the rate limit is used up Cause: Braze limits each endpoint per workspace, and your other integrations share the limit. Some limits depend on your contract. Fix: Wait as long as the answer says. Batching uses the limit less, because most endpoints take 50 ids in one call. ### A send says success, but nobody got the message Cause: Success means Braze accepted the request. Delivery still depends on the user existing, their subscription state and the channel. Fix: Check the campaign's numbers with braze_get_campaign_overview, and the person's profile with braze_find_user. Allow a few minutes after creating a user before an API-only send. ### A dashboard user tool says it needs a SCIM token Cause: A REST API key can't manage dashboard users. Fix: Make a token and service origin under Settings, Admin Settings, SCIM Provisioning, then reconnect Braze with both under More options. If you can't see that page, ask your Braze account manager about your edition. --- Source: https://www.docs.popmcp.com/docs/integrations/braze/