Braze
Send Encatch survey events to Braze - where to find the details in Braze and how to set up the connection
Beta. This connector is built from Braze's public API documentation and is waiting for its first confirmation on a live Braze account. The steps below are a high-level guide: menu names in Braze may differ slightly. Use Test connection and Logs to confirm your set-up, and tell us what you find.
Overview
The Braze connector sends survey events to Braze as custom events on the user, so a survey answer can trigger a Canvas or a campaign.
| What it gets | Survey events as custom events |
| Events | Survey shown, started, submitted, partially submitted and dismissed |
| Anonymous respondents | Not sent: identified users only |
| User profile | Not updated yet: events only |
| Status | Beta |
What You'll Need
Before you start, make sure you have:
- A Braze workspace — and the address of the dashboard you sign in at
- A REST API key — with the
users.trackpermission (Step 1)
Step 1: Create a REST API key in Braze
- In Braze, open Settings → APIs and Identifiers → API Keys.
- Create an API key with the users.track permission and copy it.
- Note your instance from the address you sign in at, for example
dashboard-01.braze.comis US-01 anddashboard-01.braze.euis EU-01.
Step 2: Add the connection in Encatch
- In Encatch, open Data sync → Survey events and click Add connection.
- Choose Braze.
- Enter a Name you'll recognise in the list and in Logs.
- Fill in the Braze settings:
| Field | What to enter |
|---|---|
| REST endpoint | Your Braze instance, by the dashboard address you sign in at. |
| REST API key | The API key with the users.track permission. |
- Press Test connection. Encatch shows what Braze answered.
Encatch keeps the keys encrypted and never shows them again. To change one later, press Replace.
Step 3: Choose what to send
- Under Surveys, choose All surveys or Only these surveys.
- Under What is sent, tick the events to send. A new connection starts with Survey shown, started, submitted and dismissed ticked. Survey partially submitted is off until you tick it.
- Rename an event if you want another name in Braze. The defaults are
encatch_survey_shown,encatch_survey_started,encatch_survey_submitted,encatch_survey_partialandencatch_survey_dismissed. - Open Advanced options to choose how users are identified, whether answers are sent and the rate limit.
Every option is explained in Connection settings.
Step 4: Save and start sending
Click Save. Saving does not start sending: press Start sending when you are ready. From then on events go out as they happen, and every delivery is listed in Logs.
Check it in Braze
After Test connection, look for the event encatch_test_event in Braze, for example on a user's profile or under custom events in your data settings.
Good to know
- New profiles. Braze creates a profile for any user ID it does not have yet; each event counts toward your Braze data points.
- Events only. Braze gets the events; Encatch does not set user attributes in Braze yet, so Update the user's profile is shown off.
- Rate limit. Braze's limit depends on your contract: see the API Usage Dashboard in Braze (Settings → APIs and Identifiers). Its published burst limit is 3,000 requests per 3 seconds.
- Also send the email. Braze keeps the email in its own field next to the user ID. Turn the option on in Advanced options to send it.
Was this page helpful?
