Skip to content

Reference

Braze

Connect Braze to Alter Vault for secure API access

Use Braze credentials to make authenticated API calls through Alter Vault without exposing API keys in code.

PropertyValue
Provider IDbraze
CategoryMarketing
Credential TypeBearer Token

Log in to Braze

Log in at dashboard.braze.com — you will be redirected to your cluster at dashboard.braze.com/sign_in.

Go to Settings → API Keys

Go to Settings → API Keys at dashboard.braze.com/app_settings/api_settings/.

Create a new API key

Click ‘Create New API Key’ and configure permissions.

Copy the REST API key

Copy the generated REST API key.

Find your instance URL

Find your instance URL on the dashboard (e.g. rest.iad-02.braze.com) for the Instance URL field.

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add Braze

Go to Managed Secrets > Add Provider > Braze.

Enter credentials

Paste your REST API Key into the credential field, and your Instance URL (e.g. rest.iad-02.braze.com) into the Instance URL field.

Save

Click Save. You’ll receive a grant_id to use with the SDK.

response = await alter_app.request(
HttpMethod.GET,
"https://YOUR_BRAZE_INSTANCE_URL/campaigns/list",
grant_id="YOUR_GRANT_ID",
)
  • Your Braze dashboard URL is cluster-specific. Log in via dashboard.braze.com to be redirected to your cluster automatically.

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation IDFamiliesMethodProvider path
post:/messages/sendsendPOST/messages/send
post:/campaigns/trigger/sendsendPOST/campaigns/trigger/send
post:/canvas/trigger/sendsendPOST/canvas/trigger/send
post:/transactional/v1/campaigns/{campaign_id}/sendsendPOST/transactional/v1/campaigns/{campaign_id}/send
post:/messages/schedule/createsend, writePOST/messages/schedule/create
post:/messages/schedule/updatesend, writePOST/messages/schedule/update
post:/messages/schedule/deletedeletePOST/messages/schedule/delete
post:/campaigns/trigger/schedule/createsend, writePOST/campaigns/trigger/schedule/create
post:/campaigns/trigger/schedule/updatesend, writePOST/campaigns/trigger/schedule/update
post:/campaigns/trigger/schedule/deletedeletePOST/campaigns/trigger/schedule/delete
post:/canvas/trigger/schedule/createsend, writePOST/canvas/trigger/schedule/create
post:/canvas/trigger/schedule/updatesend, writePOST/canvas/trigger/schedule/update
post:/canvas/trigger/schedule/deletedeletePOST/canvas/trigger/schedule/delete
post:/sends/id/createwritePOST/sends/id/create
get:/messages/scheduled_broadcastsreadGET/messages/scheduled_broadcasts
post:/users/trackwritePOST/users/track
post:/users/deletedeletePOST/users/delete
post:/users/identifywritePOST/users/identify
post:/users/mergewritePOST/users/merge
post:/users/alias/newwritePOST/users/alias/new
post:/users/external_ids/removedeletePOST/users/external_ids/remove
post:/users/external_ids/renamewritePOST/users/external_ids/rename
post:/users/export/idsreadPOST/users/export/ids
post:/email/blacklistwritePOST/email/blacklist
post:/email/blocklistwritePOST/email/blocklist
post:/email/bounce/removewritePOST/email/bounce/remove
post:/email/spam/removewritePOST/email/spam/remove
post:/email/statuswritePOST/email/status
get:/email/hard_bouncesreadGET/email/hard_bounces
get:/email/unsubscribesreadGET/email/unsubscribes
post:/subscription/status/setwritePOST/subscription/status/set
post:/v2/subscription/status/setwritePOST/v2/subscription/status/set
get:/campaigns/listreadGET/campaigns/list
get:/campaigns/detailsreadGET/campaigns/details
get:/canvas/listreadGET/canvas/list
get:/canvas/detailsreadGET/canvas/details
post:/templates/email/createwritePOST/templates/email/create
post:/templates/email/updatewritePOST/templates/email/update
get:/templates/email/listreadGET/templates/email/list
get:/templates/email/inforeadGET/templates/email/info

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.