Permutive
Send Encatch survey events to Permutive - where to find the details in Permutive and how to set up the connection
Beta. This connector is built from Permutive's public API documentation and is waiting for its first confirmation on a live Permutive account. The steps below are a high-level guide: menu names in Permutive may differ slightly. Use Test connection and Logs to confirm your set-up, and tell us what you find.
Overview
The Permutive connector sends survey events to Permutive as events on the user, so survey answers can feed your cohorts.
| What it gets | Survey events on the user |
| Events | Survey shown, started, submitted, partially submitted and dismissed |
| Anonymous respondents | Not sent: identified users only |
| Status | Beta |
What You'll Need
Before you start, make sure you have:
- A Permutive workspace
- A Private API key (Step 1). A Public key cannot be used from a server
- Your identifier tag — the identifier your Permutive SDK already identifies users with
- Schema rows added by Permutive's team — Permutive accepts an event only after its team adds the event and its properties to your schema
Step 1: Get your key and identifier tag in Permutive
- In Permutive, open Settings → Keys and click Add Key. Choose the type Private and copy the key.
- Open Identity → Identifiers and note the tag your SDK identifies users with. Tags are case-sensitive.
Step 2: Add the connection in Encatch
- In Encatch, open Data sync → Survey events and click Add connection.
- Choose Permutive.
- Enter a Name you'll recognise in the list and in Logs.
- Fill in the Permutive settings:
| Field | What to enter |
|---|---|
| Private API key | The Private API key. |
| Identifier tag | The tag from Identity → Identifiers, exactly as set up in Permutive, for example internal_id. |
| Fallback identifier tag | Optional. The tag for users sent under the connection's fallback identifier. Leave it empty to skip those events. |
Once you tick the events, the form shows Ask Permutive to add: the schema rows for those events. Copy them, send them to Permutive's team, and start the connection once they confirm.
- Press Test connection. Encatch shows what Permutive 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 Permutive. 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 Permutive
Test connection checks the Private API key by reading your Permutive cohorts: nothing is written in Permutive and no test user is made. Your schema is not checked by the test. The first real event is, and Logs show what Permutive answered.
Good to know
- Match the identity. Set Identify users by (Advanced options) to the value your SDK identifies users with, so survey events join the same people. By email, Permutive gets it hashed (SHA-256), as its
email_sha256identifier takes it. - Form details are fixed. Permutive gets the form's ID, name and slug as
survey.id,survey.nameandsurvey.slug: its schema cannot follow renamed properties. - Event time. Permutive keeps the time an event arrives; the time it happened is sent as
occurred_at. - Rate limit. Permutive does not publish a limit.
Was this page helpful?
