Compass logo

Working with Zapier

Zapier is a platform that lets you connect all of your favorite apps together. This article outlines how to use Compass webhooks with Zapier to transfer information collected in Sessions to Zapier.

Step by step video overview

Step by step instructions

1. Start a new Zap

Get started by opening Zapier and starting a new Zap. Choose the "Webhooks" option from the list of built-in apps.

Zapier user interface showing the webhook app

Then select the "Catch Hook" option.

Zapier user interface showing the catch hook trigger

Copy the link provided by Zapier. WAIT! Do not click "Ok, I did this" yet. First, we need to send a sample of data to Zapier so that it knows what data to expect to use for your actions.

Zapier user interface showing the webhook link url

2. Setup in Compass

Now with the copied link, open Compass and navigate to Manage > Workflows and select the Workflow you want to use.

Compass user interface showing how to navigate to the workflows page.

Now select a section on the diagram where the trigger will take effect.

Compass user interface showing the workflow diagram view.

After you select a section, the right side panel will open. Choose "Add Action."

Compass user interface showing the add action button on a section in the workflow.

Choose "Webhooks" integration and "Send Message" option.

Compass user interface showing the webhook action option.

Paste in the URL provided by Zapier in the URL field of the action. Lastly, choose the "End of Session" timing option to complete the action setup.

Compass user interface showing the webhook url option

3. Make a test session in Compass to send sample data to the Zap in Zapier

Now we need to create a new session in Compass for the workflow that uses the new webhook action. Make sure you choose a route that triggers the webhook action and complete all fields.

Note: only fields that have been filled out will be sent to Zapier. Make sure all of the fields you need are attached to the workflow sections and they are completed during this session.

4. Complete the Zap setup

After you've completed the session to send the sample data to Zapier, you should choose the "Ok, I did this" button to continue to further setup.

Zaper user interface showing the Ok I did this button for the zap.

If the session was able to successfully send its data to Zapier, then you should be able to click the dropdown arrow and see data sent.

Zapier user interface showing that it received the data from Compass

If everything looks correct, go ahead and choose "Continue."

Now you need to choose an app to connect with. In this example, we're going to use the data from Compass to enter a new row in a spreadsheet using Google Sheets.

Zapier user interface showing selecting the Google Sheets app

Then choose the "Create Spreadsheet Row" option.

Select your Google account, spreadsheet, and worksheet where the data will be sent.

Here is a view of the spreadsheet we are working with in this example.

Google sheet example blank spreadsheet

Now in Zapier, we should see a list of available options from our dataset. In our example, we see Date, First Name, Last Name, Status and Time.

Mapping the data from Compass to other apps in Zapier is very simple. Any property that starts with "Field." indicates that it was a field completed in Compass during the session.

Zapier user interface showing how to map data sent from Compass to other apps

Go through each property and map the data to it. Afterwards, it should look something like the screenshot below.

Zapier user interface showing the completed setup for Google Sheets with data sent from Compass.

Choose "Continue" and then you can proceed with sending test data or skip it. As the final step, choose to turn on your Zap and give it a name.

Zapier user interface showing how to turn on the completed Zap.

5. You’re all ready to go!

Now that everything is setup between Compass and Zapier you can create another session to make sure everything works as expected.

Compass user interface showing a completed session with a webhook that sent data to Zapier.

Here is an example of the data sent from Compass to our spreadsheet in Google Sheets after a session is completed.

Google sheet example of data sent from Zapier and Compass.

Great! Now you know how to use the power of Zapier to connect all of your apps with Compass.

© 2019 Pacific Northwest Innovative Technologies, LLC