Batch
Send Encatch survey events to Batch - where to find the details in Batch and how to set up the connection
Beta. This connector is built from Batch's public API documentation and is waiting for its first confirmation on a live Batch account. The steps below are a high-level guide: menu names in Batch may differ slightly. Use Test connection and Logs to confirm your set-up, and tell us what you find.
Overview
The Batch connector sends survey events to Batch profiles and, if you choose, the user's traits as profile attributes.
| What it gets | Survey events on profiles, with optional profile attributes |
| Events | Survey shown, started, submitted, partially submitted and dismissed |
| Anonymous respondents | Not sent: identified users only |
| User profile | Updated with the user's traits when Update the user's profile is on |
| Status | Beta |
What You'll Need
Before you start, make sure you have:
- A Batch project
- Its Project key and REST API key — from the general settings (Step 1). The REST API key is shown to users with the Administrate role
Step 1: Get your keys in Batch
- In Batch, open Settings → General.
- Copy the Project key. It starts with
project_. - Copy the REST API key. It is company-wide and can send messages: keep it safe.
Step 2: Add the connection in Encatch
- In Encatch, open Data sync → Survey events and click Add connection.
- Choose Batch.
- Enter a Name you'll recognise in the list and in Logs.
- Fill in the Batch settings:
| Field | What to enter |
|---|---|
| Project key | The Project key (project_…). |
| REST API key | The REST API key. |
- Press Test connection. Encatch shows what Batch 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 Batch. 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 Batch
After Test connection, open Data → Profile data in Batch and confirm the new event and attributes there. Batch asks you to confirm them before automations can use them.
Good to know
- Event names. Batch takes lowercase letters, numbers and
_only, up to 30 characters. The default names fit. - Attribute names are made to fit Batch the same way, for example an answer key
How_Satisfiedbecomeshow_satisfied. - New profiles. Batch creates a profile for any user ID it does not have yet.
- Late events. Batch refuses event times older than 24 hours: a late event is sent without its time, so Batch uses the time it arrives.
- Rate limit. Batch takes 300 profile updates a second, so a limit is rarely needed.
Was this page helpful?
