Unlock the full potential of your subscription business by syncing data from your data warehouse to Maxio
Supported syncing
| Type | Description | Supported Sync Modes | API Reference |
|---|---|---|---|
| Customers | Sync data from any source to Customers | Upsert, Update, Insert | Customers docs |
| Subscriptions | Sync data from any source to Subscriptions | Upsert, Update, Insert | Subscriptions docs |
| Usage | Sync data from any source to Usage | Insert | Usage docs |
| Events | Sync data from any source to Events-Based Billing | Insert | Event docs |
For more information about sync modes, refer to the sync modes docs.
Connect to Maxio
Go to the Destinations overview page and click the Add destination button. Select Maxio and click Continue. You can then authenticate Hightouch to Maxio by entering the following required fields into Hightouch:
- Subdomain: Part of your URL, for example,
example-subdomaininhttps://example-subdomain.chargify.com - API key: A valid Maxio API key, follow Maxio's instructions to view or create a new API key
- Password: The same one you used to log into your account
Sync configuration
Once you've set up your Maxio destination and have a model to pull data from, you can set up your sync configuration to begin syncing data. Go to the Syncs overview page and click the Add sync button to begin. Then, select the relevant model and the Maxio destination you want to sync to.
Syncing customers
When syncing customers, you can choose from upsert, update, or insert modes.
Record matching
To match rows from your model to customers in Maxio, you need to select a model column and corresponding Maxio field. You can match on any of the following Maxio fields:
- id
- reference
In Insert mode, Maxio automatically generates an identifier for every new record synced, so there is no need to match an existing record.
Field mapping
You can map data from any of your model columns to fields in Maxio. Maxio requires the following fields, so you must map them to complete your configuration:
- first_name
- last_name
Ensure the data types of your model columns match the data types of the fields you want to sync to.
Delete behavior
The delete behavior you select dictates what to do when a row no longer appears in your model's query results. You have the following options:
| Behavior | Description |
|---|---|
| Do nothing | Keep the record in Maxio with all its synced fields |
| Clear | Unset all the mapped fields, but keep the record in Maxio |
| Delete | Delete the synced record from your Maxio customer |
Syncing subscriptions
When syncing subscriptions, you can choose from upsert, update, or insert modes.
Record matching
To match rows from your model to records in Maxio, you need to select the model column that contains values that match the reference field.
In Insert mode, Maxio automatically generates an identifier for every new record synced, so there is no need to match an existing record.
Field mapping
You can map data from any of your model columns to fields in Maxio. Maxio requires the following fields, so you must map them to complete your configuration:
- customer_attributes, customer_id or customer_reference
- payment_profile_id
- product_handle or product_id
Ensure the data types of your model columns match the data types of the fields you want to sync to.
Syncing usage data
Hightouch lets you report usage events to Maxio. To do so, you must select the Maxio subscription and component you would like to sync to.
Record matching
Maxio automatically generates an identifier for every new record synced, so there is no need to match an existing record.
Field mapping
You can sync columns from your model to Maxio default usage fields. Check out Maxio's usage docs to learn more.
Syncing events
Maxio requires the following event parameters:
api-handle: You can either provide a static value or select to use a column from your model.subdomain: Hightouch uses the subdomain you entered when connecting to Maxio
Event timestamp
You can optionally select a column that contains timestamps of when events occurred. If this field is empty, Hightouch uses the time the event arrives at the server. Hightouch syncs the timestamp as the event_time parameter the Maxio requires.
Record matching
Maxio automatically generates an identifier for every new event synced, so there is no need to match an existing record.
Field mapping
Hightouch lets you sync event properties via default and custom mappings.
Tips and troubleshooting
Common errors
To date, our customers haven't experienced any errors while using this destination. If you run into any issues, please don't hesitate to . We're here to help.
Live debugger
Hightouch provides complete visibility into the API calls made during each of your sync runs. We recommend reading our article on debugging tips and tricks to learn more.
Sync alerts
Hightouch can alert you of sync issues via Slack, PagerDuty, SMS, or email. For details, please visit our article on alerting.