If you would first like to learn more about the integration, refer to this article.

If you have not yet installed the Salesforce native integration, do this first using the article here.

Configuring the App

Once the app has been installed, you will need to connect it to your zkipster account. From the app menu in Salesforce, select ‘zkipster setup.’

The first time you open it, you will be prompted to enter your API key, base URL, and choose the user who will be notified when actions like syncing are a success or failure.


You can find the API key in the API Access section within your zkipster ‘Account Settings.’

Please note: It is possible to regenerate the API key if you need to for security reasons, and this would then need to be updated in your Salesforce connection.


The base URL is currently https://api.zkipster.com/v1 (also available in zkipster’s API documentation via the API Access section in Account Settings).

Once saved, you will get a green confirmation message saying Configured Successfully. If there are any errors, make sure that the URL and/or API key are correct.

Please note: If you do not see this screen at all, you should ensure you have set up your own custom Salesforce domain. For zkipster, this is zkipster.salesforce.com.

Syncing for the first time

Once the API is saved, you should perform a manual sync to establish the connection between the two systems. Still within ‘zkipster Setup,’ click on the manual sync tab and initiate the sync. You can choose to include past events; however, for the first sync, it is recommended that you don’t as this will slow the process down.

When the sync has been completed, any upcoming events will now show in Salesforce.

You can check by going to ‘zkipster Events’ and select to view ‘All Events.’ You can also drill down to Guest Lists and Guests. At this stage, only default zkipster guest fields will show for any guest that has been created by the sync.

The next step is to map the custom fields in the ‘zkipster Setup.’

Mapping Custom Fields

Any custom fields from zkipster will be available to map to the guest or contact custom fields in Salesforce.

In the mapping section of the zkipster setup, you will see any contact custom fields you have already created. To map to the Guest object, you must create those custom fields in the Guest Object, you can do this by clicking ‘Create Custom Field’.

When syncing guests from zkipster to Salesforce the app uses the email address to search for existing contacts in Salesforce.

  1. If there is a match, the guest in the zkipster Guest object will be connected to the Salesforce contact.

  2. If there is no match, a new Salesforce contact will be created.

  3. If the email address is missing in zkipster, a new contact will be created in Salesforce.

Creating Guest Object Custom fields

To create a Guest Object custom field, click on ‘Create Custom Field’ in the setup screen. This takes you to the Salesforce Object manager for the Guest Object. Here you can click on a new field and create each of the fields you need.

Most users, can select the field type ‘text’ and set the length of the field. Advanced users will be able to make full use of the options according to their field requirements. We always recommend using the maximum character length on the field of 200 when creating.

Once you have created all of the custom fields, you can return to ‘zkipster Setup’ to complete the mapping of the fields.

Mapping fields

Once you have created the required contact & guest custom fields - and have also completed sync - you will be able to map the zkipster fields to the custom fields.

Go to ‘Custom Field Mapping’ in ‘zkipster Setup’. The new Guest custom fields you have created will now be available to be mapped.

Guest object fields will be created for each guest at every event; they are added like custom fields in zkipster.

  1. Contact custom fields only exist once.

  2. Mapping a zkipster field to a guest custom field means that data points will exist multiple times and will be event-specific.

  3. Mapping a zkipster field to a contact custom field means that the data point exists once and will be updated or deleted any time that field is changed in an event in zkipster.

Once the fields have been mapped, you should initiate another manual sync. After that, the contact & guest custom fields will be populated with any data from zkipster, or any custom fields in zkipster should be populated with data from Salesforce depending on the flow of data.

Here is an example:

The picture below shows the Contact object for ‘John Smith’ with the zkipster custom fields mapped to Contact Fields 1,2,3. Updates to these fields in zkipster will show here only.

This shows the Guest object for ‘John Smith’ at an event with the zkipster custom fields mapped to Guest Fields 1,2,3. Updates to these fields in zkipster will show here only.

To be able to see what Guest Lists the contact has been added to as a guest, your administrator can add a zkipster Guest as a related list in the Contact Layout.

They do this in Setup>Object Manager>Contact>Page Layout>Contact Layout

Once added they can click on the spanner to select the fields they want to show.

Once they have made their selection they need to save the layout changes at the top left and then can visit a contact to check it’s setup correctly.

That's it!

You are now ready to add the ‘Add to Guest List’ button to your Contacts view in Salesforce. To learn how to do this, follow this article here.

If you have questions, reach out to the Client Relations team via the web chat on the bottom right side of your screen.

Did this answer your question?