Skip to content

Latest commit

 

History

History
146 lines (92 loc) · 6.09 KB

apollo.md

File metadata and controls

146 lines (92 loc) · 6.09 KB
description
This page describes how to use Census with Apollo.

Apollo

Getting Started

In this guide, we will show you how to connect Apollo to Census and create your first sync.

Prerequisites

1. Create an Apollo API key

Apollo lets you create a number of API keys, each with their own set of permissions. You'll almost certainly want to create a new API key for Census rather than reusing an existing one.

Launch Apollo and click Settings > Integrations.

Then, find the API option and click Connect.

Next, API keys to view or create new API keys. Then, click Create New Key.

Name your API Key and add a description ("Census" is a good choice). To scope your key appropriately, click the checkbox for each Apollo API endpoint you need to access. Select Set as Master Key.

Click Create API Key.

Finally, copy the code you see under API Key. We'll use that in a minute.

2. Connect Census to Apollo

Great! Now let's pull it all together.

  1. In the Destinations page, click on New Destination, and select "Apollo"
  2. You can provide whatever name you like for the connection
  3. Paste your Apollo API Key
  4. Click Connect

Census will test your API key and show a green checkmark ✅ when successful.

3. Connect to your Data Warehouse

Please follow one of our short guides depending on your data warehouse technology

4. Create your first Model

Now navigate to the Model page in Census

Here you will have to write SQL queries to select the data you want to see in Apollo. Here are some ideas of data you should select:

  • Customer attributes like name, organization, title, email, etc.
  • Account attributes like name, domain, phone number, address

Once you have created your model, click Save Model.

5. Create your first Sync

Now head to the Sync page and click the Create a Sync button

In the "What data do you want to sync?" section

  • For the Connection, select the data warehouse you connected in step 3
  • For the Source, select the model you created in step 4

Next up is the "Where do you want to sync data to?" section

  • Pick Apollo as the Connection
  • For Object, pick the one you want to sync data to: Account or Contact

For the " How do you want to update the destination?" section

  • Select Update or Create or Update Only
  • Pick the right mapping key.
    • If you select Update or Create, it will be:
      • Email for Contacts, or
      • Name for Accounts
    • If you select Update Only, it will be:
      • ID or Email for Contacts, or
      • ID or Name for Accounts

Finally, select the properties you want to update in the Mapper in the "Which properties should be updated?" section

  • Here simply map the fields from Apollo to the column from your model.

The end result should look something like this

Click the Next button to see the final preview which will have a recap of what will happen when you start the sync

6. Confirm the data is in Apollo

Now go back to your Apollo account and go view a record type (Contact or Account) that should have been updated. If everything went well, you should see your data in Apollo.

That's it! In 6 steps, you connected Census to Apollo and started syncing customer & account data from your warehouse to Apollo🎉

Supported Objects

Census currently supports syncing to the following Apollo objects.

Object Name Supported? Identifiers
Account ✅ ID, Name
Contact ✅ Email

Contact us if you want Census to support more objects for Apollo.

Supported Sync Behaviors

{% hint style="info" %} Learn more about all of our sync behaviors in our Syncs documentation. {% endhint %}

Behaviors Supported? Objects
Update or Create ✅ Account, Contact
Update Only ✅ Account, Contact

Contact us if you want Census to support more sync behaviors for Apollo.

Need help connecting to Apollo?

Contact us via [email protected] or start a conversation with us via the in-app chat.