Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Braze (BYOK) — connector documentation

  • MCP endpoint: https://byok-braze.connectorbay.com/mcp
  • REST API: POST https://byok-braze.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-braze.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Braze REST API key (needs the matching list/details permissions), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-braze.connectorbay.com/health · Tool schemas: https://byok-braze.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-braze · agent@connectorbay.com

What Braze (BYOK) is for

Braze (BYOK) lets an AI assistant read your own Braze data through the Braze API with a key you supply (REST API key (needs the matching list/details permissions)). Read-only: 10 tools (list_campaigns, get_campaign_details, get_campaign_analytics, list_canvases, list_segments, list_custom_events, get_new_users_series, get_daily_active_users_series, list_email_templates, list_content_blocks). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to rest.iad-01.braze.com, rest.iad-02.braze.com, rest.iad-03.braze.com, rest.iad-04.braze.com, rest.iad-05.braze.com, rest.iad-06.braze.com, rest.iad-07.braze.com, rest.iad-08.braze.com, rest.us-10.braze.com, rest.au-01.braze.com, rest.id-01.braze.com, rest.jp-01.braze.com, rest.kr-01.braze.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Braze. Braze and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "What campaigns do I have in Braze, newest first?"
  • "When was this Braze campaign first and last sent, and on which channels?"
  • "How did this Braze campaign perform over the last 14 days?"
  • "Which Canvases exist in my Braze workspace?"
  • "Which Braze segments have analytics tracking enabled?"
  • "What custom events does Braze know about?"

What it does

  • list_campaigns: List campaigns (id, name, last edit time, tags, whether API-triggered), 100 per page. Needs the campaigns.list permission.
  • get_campaign_details: Get one campaign's name, description, schedule type, channels, first and last send, tags, teams and enabled/draft/archived flags (message bodies are not returned). Needs campaigns.details.
  • get_campaign_analytics: Get a daily series for one campaign: unique recipients, conversions and revenue per day. Needs campaigns.data_series.
  • list_canvases: List Canvases (id, name, last edit time, tags), 100 per page. Needs the canvas.list permission.
  • list_segments: List segments (id, name, whether analytics tracking is on, tags), 100 per page. Needs the segments.list permission.
  • list_custom_events: List the names of custom events recorded in the workspace, alphabetically, 250 per page. Needs the events.list permission.
  • get_new_users_series: Get the number of new users per day for the last N days (1 to 100), optionally for one app. Needs kpi.new_users.data_series.
  • get_daily_active_users_series: Get daily active users per day for the last N days (1 to 100), optionally for one app. Needs kpi.dau.data_series.
  • list_email_templates: List email templates (id, name, created, updated, tags); drag-and-drop templates are not included. Up to 1000 per call.
  • list_content_blocks: List Content Blocks (id, name, html or text type, Liquid tag, inclusion count, dates, tags). Up to 1000 per call.

BYOK key

You bring your own Braze REST API key (needs the matching list/details permissions) (https://www.braze.com/docs/api/basics/#rest-api-key). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to rest.iad-01.braze.com, rest.iad-02.braze.com, rest.iad-03.braze.com, rest.iad-04.braze.com, rest.iad-05.braze.com, rest.iad-06.braze.com, rest.iad-07.braze.com, rest.iad-08.braze.com, rest.us-10.braze.com, rest.au-01.braze.com, rest.id-01.braze.com, rest.jp-01.braze.com, rest.kr-01.braze.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Braze API (rest.iad-01.braze.com, rest.iad-02.braze.com, rest.iad-03.braze.com, rest.iad-04.braze.com, rest.iad-05.braze.com, rest.iad-06.braze.com, rest.iad-07.braze.com, rest.iad-08.braze.com, rest.us-10.braze.com, rest.au-01.braze.com, rest.id-01.braze.com, rest.jp-01.braze.com, rest.kr-01.braze.com) with a BYOK key; documentation: https://www.braze.com/docs/api/endpoints/export/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Braze. Braze and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Braze account.

Built for: Worldwide. Languages: English.