Prerequisites
Before you connect, make sure you have:
• Access to Integration Hub in zkipster. Your Account Permission Scheme must be Admin Access, or a custom scheme that includes the Integration Hub permission.
• A Salesforce edition with API access. API access is included in Enterprise, Performance, Unlimited and Developer editions. Professional edition only has it as a paid add-on from Salesforce.
• A Salesforce user to connect with. See Step 2 below before you start.
• Your Salesforce admin available. Salesforce requires an admin to allow or install connected apps, so plan for their involvement even on the simple sign-in path.
Please note: the Integration Hub permission is only needed to set up and manage the connection. Importing and exporting on an event is controlled by the Salesforce Integration event permission, under advanced settings, which is included in the Administrator scheme. Event users without access to Integration Hub can still import and export if their Event Permission Scheme includes it.
Step 1: Purchase the Salesforce integration add-on
In zkipster, open the account menu and go to Integration Hub.
Click the Salesforce card. If your account does not have the add-on yet, you will see an overview page with a Learn more link and a Purchase add-on button.
Click Purchase add-on. You are taken to Manage Subscription.
Add the Integration Hub Connector add-on and update your subscription.
zkipster now prepares your integration. This usually takes under a minute. While it runs, the Salesforce page shows a message that your account is being set up, with an option to refresh. When it is ready, the Purchase add-on button is replaced by Connect.
Please note: until the add-on is purchased, nothing changes in your events. Once it is active, the Salesforce import and export options appear in every event in your account.
Step 2: Choose which Salesforce user to connect with
Every record the integration creates or updates in Salesforce shows the connected user in Created By, Last Modified By and field history. If a colleague connects with their own login, their name is stamped on every Lead and Campaign Member the integration touches.
We recommend a dedicated integration user, named so the audit trail reads clearly. For example, First Name zkipster and Last Name Integration.
Your situation | Recommended option |
You have a spare or unused Salesforce licence | Turn it into a dedicated user and connect with OAuth 2.0 |
No spare licence, and you do not want to add one | Use a Salesforce Integration licence and connect with JWT |
You want a dedicated user and are happy to add a seat | Create a new standard user and connect with OAuth 2.0 |
Small team, one person runs events | Connect with your own user via OAuth 2.0 |
Please note: zkipster does not require you to buy an extra Salesforce licence.
Step 3: Connect with OAuth 2.0
OAuth 2.0 is the quickest option. You sign in to Salesforce and approve access, with no certificates or keys.
Please note: if you are connecting with a Salesforce Integration licence, follow How to Connect zkipster with a Salesforce Integration User (JWT) instead.
In Integration Hub, click the Salesforce card, then Connect.
On the Setup tab, choose OAuth 2.0 as the authentication type. The Settings tab stays disabled until the connection is complete.
If you want to test first, you can connect a Salesforce sandbox instead of your production account. See Moving from a sandbox to production below.
Click Connect. A Salesforce login window opens.
Sign in with the Salesforce user you chose in Step 2. If you have access to several Salesforce accounts, pick the right one.
Salesforce shows an approval screen for an app called Workato connector, with the list of access it requests. Click Allow.
You return to zkipster with a success message and are taken to the Settings tab.
Please note: Workato is the secure connection service zkipster uses behind the scenes. Its name appears only on the Salesforce approval screen and in your Salesforce Setup > Connected Apps OAuth Usage list. Your data is not managed in a separate Workato account, and you do not need one.
Pro Tip: On the approval screen, Salesforce offers several permission options, with Full access selected by default. The integration works with both Full access and the minimum permission option. If your security policy requires least-privilege access, you can choose the minimum option.
Step 4: Set up the Lead field (optional)
After connecting, the Settings tab asks you to choose one Salesforce Lead field. This step is optional, but it is required if you want to export guests who were created directly in zkipster, such as walk-ins. See How to Set Up the Lead Field for the Salesforce Integration.
Checking or removing the connection
Once connected, the Salesforce card in Integration Hub shows two options: Activity Log and Configure integration.
To disconnect, reconnect or switch to a different Salesforce user, go to Integration Hub, click the Salesforce card, then Configure integration, and open the Setup tab. To switch users, disconnect, then connect again as the other user. Your zkipster account can have only one Salesforce connection at a time.
If the connection has expired or been removed, anyone who starts a Salesforce import or export sees a message that Salesforce isn’t connected, with a button to go to Integration Hub.
In Salesforce, your admin can see who is connected under Setup > Connected Apps OAuth Usage, in the Workato connector entry. Each person who has authorised the connection appears as a separate user. Revoking a user there stops the integration for that connection immediately.
Moving from a sandbox to production
1. In the Setup tab, disconnect the sandbox.
2. Connect again with Sandbox set to No.
3. In the Settings tab, select the Lead field again. The field must exist in your production Salesforce org.
Please note: guests imported while connected to the sandbox stay linked to the sandbox records. Run your tests on a test event, not on a live one.