Userlist
Send Encatch survey events to Userlist - where to find the details in Userlist and how to set up the connection
Beta. This connector is built from Userlist's public API documentation and is waiting for its first confirmation on a live Userlist account. The steps below are a high-level guide: menu names in Userlist may differ slightly. Use Test connection and Logs to confirm your set-up, and tell us what you find.
Overview
The Userlist connector sends survey events to Userlist as user events, ready to trigger campaigns and build segments.
| What it gets | Survey events as user events |
| 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 Userlist account
- Its Push API key (Step 1)
Step 1: Get your Push API key in Userlist
- In Userlist, open Settings → Push API (
app.userlist.com/settings/push). - Copy the Push API key.
Step 2: Add the connection in Encatch
- In Encatch, open Data sync → Survey events and click Add connection.
- Choose Userlist.
- Enter a Name you'll recognise in the list and in Logs.
- Fill in the Userlist settings:
| Field | What to enter |
|---|---|
| Push API key | The Push API key. |
- Press Test connection. Encatch shows what Userlist 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 Userlist connection starts with Survey submitted only, because Userlist bills by user and its Basic plan limits custom events. Tick the other events if you want them.
- Rename an event if you want another name in Userlist. 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 Userlist
After Test connection, look for the event encatch_test_event on a user in Userlist.
Good to know
- Event names. Userlist stores event names in snake_case, so
Survey Submittedis stored assurvey_submitted. The form shows the stored name under the field. - New users. Userlist creates a user for any user ID it does not have yet, and bills by user.
- Plan limits. The Userlist Basic plan allows 20 custom events and 20 custom properties.
- Rate limit. A new connection starts at 500 a minute. Userlist takes 1,000 requests a minute per account, counting users, companies and events together.
- Also send the email. Userlist 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?
