Connect integration
connect_integrationConnect a tool so its people sync in as contacts, in a list of their own, every 6 hours: Mixpanel (projectId, username, secret = a service account; sourceId = cohort id), Amplitude (apiKey, secretKey, sourceId), HubSpot (accessToken), Shopify (shopDomain, accessToken), Salesforce, or a webhook. Takes the event or property that shows people agreed to texts (consentEvent / consentField) and the property that holds their phone (phoneField). Credentials are proved with one read, sealed, and never returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Mixpanel / Amplitude: pull with credentials every 6 hours (default when credentials are sent), or push: no credentials, the tool's cohort sync posts to the ingest URL. | |
| name | No | What to call it (default: the tool and its source). | |
| apiKey | No | Amplitude API key. | |
| region | No | Mixpanel / Amplitude data residency. | |
| secret | No | Mixpanel service account secret. | |
| clientId | No | Salesforce consumer key, or Shopify client id. | |
| provider | Yes | ||
| sfObject | No | ||
| sourceId | No | Mixpanel or Amplitude cohort id; HubSpot list id; Salesforce campaign id; a Shopify customer search. Blank = everyone (HubSpot, Shopify, Salesforce). | |
| username | No | Mixpanel service account username. | |
| projectId | No | Mixpanel project id. | |
| secretKey | No | Amplitude secret key. | |
| phoneEvent | No | Mixpanel: an event that carries the number when profiles do not (e.g. Verification Check Success). A member with no phone on the profile gets it from their latest such event. | |
| phoneField | No | The tool's property holding the mobile number, when not the usual one ($phone, phone, mobilephone). | |
| shopDomain | No | Shopify store, like acme.myshopify.com. | |
| accessToken | No | HubSpot private app token, or Shopify Admin API access token. | |
| instanceUrl | No | Salesforce My Domain URL. | |
| clientSecret | No | Salesforce consumer secret, or Shopify client secret. | |
| consentEvent | No | Mixpanel / Amplitude: the opt-in event the cohort is built on (e.g. SMS Opt In). Everyone in the cohort is recorded as opted in, from that event. | |
| consentField | No | The tool's property that records SMS consent (e.g. sms_opt_in). | |
| phoneEventProperty | No | Mixpanel: that event's property holding the number (default phone). |