Connection settings
Every field of a Survey events connection - the tool's keys, surveys, events, user identity, answers, rate limit and sending status
Overview
Every Survey events connection is set up on one page. The top part, Connection, holds the tool and its keys. The bottom part, Events, has two tabs: General (which surveys, which events and for whom) and Advanced options (what each event carries).
This page explains the Encatch side of the form. The keys differ per tool: each connector page shows where to find them in the tool.
To open the form, go to Data sync → Survey events → Add connection and pick a tool, or click an existing connection to edit it.
Connection
| Field | What to enter |
|---|---|
| Connector | The tool you picked. It cannot be changed afterwards: add a new connection for another tool. |
| Name | A name you'll recognise in the list and in Logs, for example Amplitude production. |
| The tool's settings | The region, keys and IDs the tool asks for. Where to find your keys opens the tool's own help page. |
| Test connection | Sends one sample to the tool with the settings in the form, saved or not. |
Test connection
Press Test connection before you save. Encatch sends one sample event with the settings in the form and shows what the tool answered. For most tools the sample appears in the tool as a test event. For a few tools (HubSpot, Salesforce, Google BigQuery, Google Sheets, Permutive) the test only checks the keys and writes nothing.
Tests are listed in Logs with a Test mark.
Keys after saving
Encatch keeps keys encrypted and never shows them again. The form shows each key as saved, with a hint (its last four characters, a webhook's host, or a service account's email) so you can tell which one it is. Press Replace to paste a new key.
General
Surveys
| Choice | What it does |
|---|---|
| All surveys | Events of every survey in the project are sent, including surveys you create later. |
| Only these surveys | Pick the surveys, up to 200 per connection. |
What is sent
Tick the events to send. You can rename each one: the name you type is the name the tool stores. See Survey events for what each event means.
- Analytics, engagement, CDP and audience tools offer all five events.
- CRM, warehouse, spreadsheet, automation and feedback analysis tools offer Survey submitted (always on) and Survey partially submitted.
- Two events cannot be sent under the same name. The one exception: Survey submitted and Survey partially submitted may share a name, and the tool then tells them apart by the
encatch_eventproperty.
Include anonymous respondents (device ID)
Off by default. When on, Survey submitted and Survey partially submitted are also sent for respondents who are not signed in, under the device ID the SDK gave them. The switch is offered only for tools that can take an anonymous user.
Advanced options
Send answers with Survey submitted and partially submitted
On by default. Adds the answers to the submitted event, and the answers given so far to Survey partially submitted. Turn it off to send only the fact that a survey was submitted.
Answer keys
How each answer is named in the tool.
| Choice | Example | Notes |
|---|---|---|
| Question slug (default) | how_satisfied | A question without a slug uses its ID. |
| Question ID | q_8f2c… | Never changes, but is hard to read. |
| Question title | how_satisfied_are_you | The title in the form's default language, in lower case with _ for spaces. A repeated title gets _2, _3. |
Editing a question's slug or title starts a new property in the tool. Charts, automations and field mappings built on the old name stop getting new values.
Identify users by
Which identifier names an identified user in the tool. Choose the one the tool already knows your users by, so survey events join the same people.
| Choice | What is sent |
|---|---|
| User name (default) | The user name your app sets when it identifies the user. |
| Encatch user ID | Encatch's own ID of the user. |
| The user's email. | |
| A trait you name | The value of a user trait, for example crm_id. Enter the trait's key. |
If the user doesn't have it, use decides what happens when a user lacks the chosen identifier (or the tool refuses it): the User name, the Email, then user name, or Don't send. An event that is not sent shows as Skipped in Logs.
Anonymous respondents are not affected by this choice.
Also send the email
Offered for tools that keep the email in its own field next to the user ID (for example Klaviyo, Vero, Braze and Userlist). When on, the user's email is sent with the event so the tool can keep one profile.
Update the user's profile
When on, Survey submitted and partially submitted also send the user's Encatch traits as profile properties in the tool. Some tools get the events only for now; the switch is then shown off, with the reason under it.
Form details
Which details of the form are added to every event, and under which property name.
| Detail | Default property |
|---|---|
| Form ID (on by default) | survey_id |
| Form name | survey_name |
| Form slug | survey_slug |
A form without a slug sends an empty value. Renaming a property starts a new one in the tool. Some tools take the form's details under fixed names; the form then shows which.
Include responses submitted through the Admin API
On by default. Survey submitted is also sent for responses your servers submit with the Admin API. Turn it off to send only responses from the SDK and shareable links.
Rate limit
The most events a minute this connection sends to the tool, from 10 to 10,000. Leave it empty for no limit.
- Events above the limit wait and are sent later, in order. Retries count too.
- Two connections with the same key share the limit the tool itself sets, so split it between them.
- For tools with a known limit, a new connection starts with a safe value, about half of the tool's limit, because your other integrations count against it too. The form shows the tool's own limit under the field.
Maximum wait
How long an event may wait for a free minute: 1 hour (default), 6 hours, 12 hours or 24 hours. An event that would wait longer is not sent: it shows as Expired in Logs and can be sent again from there.
As a guide: at 3,000 events a minute and a 1 hour wait, a burst of more than about 180,000 events starts to expire.
Starting, pausing and deleting
| Status | What it means | Button |
|---|---|---|
| Not sending yet | The connection is new. Saving does not start sending. | Start sending (after the first save) |
| Sending to tool | Events go out as they happen. | Pause |
| Paused | Nothing is sent to the tool. | Resume |
- Pause takes effect at once, without saving. Events that happen while a connection is paused are not sent later.
- Changes to the form take effect when you save them.
- Deleting a connection stops it for good. Its past deliveries stay in Logs until they age out.
Next steps
- Survey events — what each event means
- Logs — outcomes, retries and sending again
- Supported tools — where to find each tool's keys
Was this page helpful?
