Skip to main content

ChurnZero Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a ChurnZero location.
churnzero_api.png

ChurnZero

Create a ChurnZero Destination​

  1. Click the + icon on the Nexset that will be sent to the ChurnZero destination, and select the Send to Destination option from the menu.

  2. Select the ChurnZero connector from the list of available destination connectors. Then, select the credential that will be used to connect to the ChurnZero organization, and click Next; or, create a new ChurnZero credential for use in this flow.

  3. In Nexla, ChurnZero destinations can be created using pre-built endpoint templates, which expedite destination setup for common ChurnZero endpoints. Each template is designed specifically for the corresponding ChurnZero endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    ChurnZero destinations can also be configured manually, allowing you to send data to ChurnZero endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common ChurnZero endpoints. Each template is designed specifically for the corresponding ChurnZero endpoint, making destination setup easy and efficient.

ChurnZero write operations are submitted to a single ingestion endpoint, where each request specifies an action (such as setAccount, setContact, or trackEvent). The pre-built templates handle this action mapping and authentication automatically, so you only need to ensure that each Nexset record contains the required identifier fields described below. All write templates use batching to group multiple records into each API call for efficient delivery.

ChurnZero identifies accounts and contacts by external IDs that you supply. Every record sent to a ChurnZero destination must include the appropriate identifier field—accountExternalId for account operations, and both accountExternalId and contactExternalId for contact and event operations.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Set Account

    Creates or updates a customer account in ChurnZero. Use this endpoint to keep ChurnZero account records in sync with your source-of-truth system.

    • Ensure that each Nexset record includes an accountExternalId field, which uniquely identifies the account in ChurnZero. This field is required.
    • Include any additional account fields or custom attributes as record fields; they will be sent with the account upsert.
    • Records are batched in groups of up to 100 per API call.

    ChurnZero performs an upsert: if an account with the given external ID exists, it is updated; otherwise, a new account is created.

    Delete Account

    Permanently deletes accounts from ChurnZero by external ID. Use this endpoint to remove accounts that should no longer exist in ChurnZero.

    • Ensure that each Nexset record includes the accountExternalId of the account to delete. This field is required.
    • Records are batched in groups of up to 50 per API call.

    Deletion is irreversible. Verify the external IDs in your Nexset before activating this destination, as deleted account data cannot be recovered.

    Set Contact

    Creates or updates a contact in ChurnZero. Use this endpoint to keep the people associated with your accounts in sync.

    • Ensure that each Nexset record includes both accountExternalId and contactExternalId, which together uniquely identify the contact within its account. Both fields are required.
    • Include any additional contact fields or custom attributes as record fields; they will be sent with the contact upsert.
    • Records are batched in groups of up to 100 per API call.

    The pairing of accountExternalId and contactExternalId forms the composite key ChurnZero uses to match contacts to accounts.

    Delete Contact

    Permanently removes contacts from ChurnZero. Use this endpoint to remove contacts that should no longer exist in ChurnZero.

    • Ensure that each Nexset record includes both accountExternalId and contactExternalId. Both fields are required.
    • Records are batched in groups of up to 50 per API call.

    Deletion is irreversible. Verify the external IDs in your Nexset before activating this destination, as deleted contact data cannot be recovered.

    Track Event

    Sends custom events to ChurnZero for a contact. Use this endpoint to record product usage and engagement activity that feeds health scores and churn models.

    • Ensure that each Nexset record includes accountExternalId, contactExternalId, and eventName. These fields are required.
    • Include any additional event metadata, such as an event date or quantity, as record fields.
    • Records are batched in groups of up to 200 per API call.

    Track Event supports the highest batch size of the write endpoints, making it well suited to high-volume engagement and usage data.

    Set Account Attribute

    Sets or updates custom attribute values on a ChurnZero account. Use this endpoint to push computed metrics or external data points onto your account records.

    • Ensure that each Nexset record includes the accountExternalId of the target account, along with the attribute name and value fields. The accountExternalId field is required.
    • Records are batched in groups of up to 100 per API call.

    This template targets the Account entity. Use the Set Contact Attribute endpoint to update attributes on individual contacts.

    Set Contact Attribute

    Sets or updates custom attribute values on a ChurnZero contact. Use this endpoint to enrich contact records with external data or computed values.

    • Ensure that each Nexset record includes both accountExternalId and contactExternalId, along with the attribute name and value fields. Both identifier fields are required.
    • Records are batched in groups of up to 100 per API call.

    This template targets the Contact entity. Use the Set Account Attribute endpoint to update attributes at the account level.

    Increment Attribute

    Increments a numeric attribute on an Account or Contact. Use this endpoint to add to a running total without first reading the current value.

    • Select the entity type to increment from the Entity Type pulldown menu. The available values are Account and Contact (case-sensitive), and the default is Account. This setting is required.
    • Ensure that each Nexset record includes the appropriate identifier field(s)—accountExternalId for Account, or both accountExternalId and contactExternalId for Contact—along with the attribute name and the increment amount.
    • Records are batched in groups of up to 100 per API call.

    Only numeric custom attributes can be incremented. Ensure the target attribute is defined as numeric in ChurnZero before using this endpoint.

Configure Manually​

ChurnZero destinations can be manually configured to send data to the ChurnZero ingestion API.

Using manual configuration, you can also configure Nexla to automatically send the response received from the ChurnZero API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the ChurnZero API from the Method pulldown menu. ChurnZero write operations are submitted using the POST method.

Data Format​

  1. Select the format in which the Nexset data will be sent to the ChurnZero API from the Content Format pulldown menu. ChurnZero accepts JSON, so select application/json. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the ChurnZero ingestion endpoint to which you want to send the Nexset data in the URL field. ChurnZero write operations are submitted to https://{subdomain}.churnzero.net/i, where {subdomain} is your account subdomain. The specific operation is determined by the action value included in the request body.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this ChurnZero destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100. The pre-built ChurnZero templates use batch sizes of 50 to 200 depending on the operation.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field. For ChurnZero, batched records are placed in a property named data.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format, such as the action value for the desired operation.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the ChurnZero API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the ChurnZero API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the ChurnZero API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the ChurnZero API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured ChurnZero endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to ChurnZero until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.