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
-
Log in to your ChurnZero account.
-
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.us1apphttps://acme.eu1app.churnzero.net→acme.eu1app
The
https://protocol and.churnzero.netare not part of the subdomain.
Step 2: Check the user's permissions
- Make sure the ChurnZero user you'll connect with has the Developer Tools user permission.
- Make sure that user's permission group has the following Bulk Read permissions. Matia syncs only the data these permissions allow.
Bulk Read - AccountsBulk Read - Churn ScoresBulk Read - ContactsBulk Read - Custom TablesBulk Read - EventsBulk Read - JourneysBulk Read - MeetingsBulk Read - MessagesBulk Read - NotesBulk Read - SurveysBulk Read - TasksBulk Read - User Accounts
Step 3: Create an API key
- Log in to ChurnZero as the user from Step 2.
- Go to Admin > API Keys.
- Click New API Key.
- Enter a Name for the key, for example
Matia, and click Ok. - 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
- Enter the Subdomain you found in Step 1.
- Enter the Username of the ChurnZero user from Step 2.
- Enter the API Key you created in Step 3.
- Enter an Asset Name.
- (Optional) Enter a Description.
- (Optional) Assign Tags.
- Select an Owner.
- Verify that your ChurnZero account is successfully connected by clicking on Test Connection.
- Click Connect.