Search documentation...

K

ChartMogul

Empower your product teams with richer data from your warehouse to perform deeper analysis on subscription revenue and better understand business performance.

Setup

To find your API keys, navigate to your profile and create a private API key.

Syncing

Hightouch supports syncing to the following ChartMogul Objects:

  • Customers
  • Invoices
  • Transactions

Sync Modes

This integration supports Upsert, Update, and Insert modes for Customers objects and Insert mode for Invoices and Transactions objects.

  • Upsert — Upsert mode pushes new objects to ChartMogul and updates fields that change in your warehouse.
  • Update — Update mode updates particular fields on existing objects in ChartMogul.
  • Insert — Insert mode pushes new objects to ChartMogul, and does not update the objects as they change in your warehouse.

Record Matching

Customers

In Upsert mode, records can be matched from your source to ChartMogul by External ID or Email.

In Update mode, records can be matched from your source to ChartMogul by External ID or ChartMogul's Customer UUID.

ChartMogul does not consider Email as a unique identifier, so upserting records will apply to all matching emails.

Field Mapping

Customers

You can sync columns from your source to ChartMogul's default and custom attributes. When syncing with Upsert or Insert mode, Data Source UUID, Name, and External ID (depending on if External ID was selected in the Record Matching section) are required fields in order for the sync to run successfully. When syncing with Update mode, Name is a required field in order for the sync to run successfully. To know more about Customer fields, refer to the docs here

Additionally when syncing custom attributes with Upsert or Insert mode, Hightouch automatically transforms your data to match the required format that ChartMogul expects for the custom field. For example, say you want to enrich a customer profile by inserting age as a custom attribute, where the object is:

{
    "attributes": {
        "custom": {
          "age": 25,
        },
    }
}

Hightouch will automatically detect the type of the record value and transform the object for you to the expected custom field format:

{
    "attributes": {
        "custom": [
            {
              "type": Integer,
              "key": "age",
              "value": 25
            },
        ]
    }
}

Invoices

You can sync columns from your source to ChartMogul's default and custom attributes. Customer UUID, External ID, Date, Currency, Line Items, and Customer External ID are required fields in order for the sync to run successfully. To know more about Invoice fields, refer to the docs here.

Transactions

You can sync columns from your source to ChartMogul's default and custom attributes. Invoice UUID, Date, Type, and Result are required fields in order for the sync to run successfully. To know more about Transaction fields, refer to the docs here.

Delete Mode

Customers

You can choose what Hightouch's behavior is when records leave the query result set. The default is doing nothing, but you can also set Hightouch to delete the Customer record.

ChartMogul does not allow custom attributes to be cleared, so Hightouch will sync "null" to the field instead.

    Need help?

    Our team is relentlessly focused on your success. We're ready to jump on a call to help unblock you.

    • Connection issues with your data warehouse?
    • Confusing API responses from destination systems?
    • Unsupported destination objects or modes?
    • Help with complex SQL queries?

    Feature Requests?

    If you see something that's missing from our app, let us know and we'll work with you to build it!

    We want to hear your suggestions for new sources, destinations, and other features that would help you activate your data.

On this page

SetupSyncingSync ModesRecord MatchingCustomersField MappingCustomersInvoicesTransactionsDelete ModeCustomers

Was this page helpful?