Skip to main content

ChurnZero Setup Guide

Prerequisites

  • A ChurnZero account with the REST API add-on enabled. If it isn't enabled yet, contact your ChurnZero Customer Success Manager.
  • A ChurnZero user with the Developer Tools user permission. Matia connects as this user.
  • The Bulk Read permissions enabled on that user's permission group (see Step 2).

Note: Bulk Read permissions are set on a User Permission Group and apply to every user in that group. Consider creating a dedicated user and permission group for Matia.

Setup Guide

Step 1: Find your subdomain

  1. Log in to your ChurnZero account.

  2. Find the subdomain in your browser's URL and make a note of it. It's everything before .churnzero.net, including the region segment. For example:

    • https://acme.us1app.churnzero.net → acme.us1app
    • https://acme.eu1app.churnzero.net → acme.eu1app

    The https:// protocol and .churnzero.net are not part of the subdomain.

Step 2: Check the user's permissions

  1. Make sure the ChurnZero user you'll connect with has the Developer Tools user permission.
  2. Make sure that user's permission group has the following Bulk Read permissions. Matia syncs only the data these permissions allow.
    • Bulk Read - Accounts
    • Bulk Read - Churn Scores
    • Bulk Read - Contacts
    • Bulk Read - Custom Tables
    • Bulk Read - Events
    • Bulk Read - Journeys
    • Bulk Read - Meetings
    • Bulk Read - Messages
    • Bulk Read - Notes
    • Bulk Read - Surveys
    • Bulk Read - Tasks
    • Bulk Read - User Accounts

Step 3: Create an API key

  1. Log in to ChurnZero as the user from Step 2.
  2. Go to Admin > API Keys.
  3. Click New API Key.
  4. Enter a Name for the key, for example Matia, and click Ok.
  5. Copy the API Key — you'll need it to configure Matia.

Note: The API key works as the password for this user's API requests. Anyone with the username and API key can read your ChurnZero data, so store it securely.

Step 4: Connect ChurnZero in Matia

  1. Enter the Subdomain you found in Step 1.
  2. Enter the Username of the ChurnZero user from Step 2.
  3. Enter the API Key you created in Step 3.
  4. Enter an Asset Name.
  5. (Optional) Enter a Description.
  6. (Optional) Assign Tags.
  7. Select an Owner.
  8. Verify that your ChurnZero account is successfully connected by clicking on Test Connection.
  9. Click Connect.