Heymarket
Heymarket provides conversational, personalized, and secure text messaging that integrates with Salesforce, HubSpot, Microsoft Teams, and other business tools.
Data integration: Skyvia supports importing data to and from Heymarket, exporting Heymarket data to CSV files, replicating Heymarket data to relational databases, and synchronizing Heymarket data with other cloud apps and relational databases.
Backup: Skyvia Backup does not support Heymarket.
Query: Skyvia Query supports Heymarket.
Establishing Connection
To create a connection to Heymarket, specify the API key.
Getting Credentials
To get an API Key, contact the support service via the Chat with Support section and request access to Heymarket API.
Creating Connection
To connect to Heymarket, specify the obtained API key in the corresponding box in the Connection Editor.
Additional Connection Parameters
Metadata Cache
You can specify the time when the Metadata Cache expires.
Suppress Extended Requests
Heymarket API returns only part of the fields for some objects when querying multiple records. Skyvia performs additional extended requests to query values of missing fields. Skyvia performs such API requests for each record of such an object. However, this can decrease performance and significantly increase the number of API calls used.
The additional fields are the following:
| OBJECT | FIELD |
|---|---|
| Contacts | AvatarFileName |
| Messages | MediaFileContent |
| TemplateFiles | Content |
You can select the Suppress Extended Requests checkbox to reduce the number of API calls.
Connector Specifics
Object Peculiarities
Contacts
Due to Heymarket API specifics, the UPDATE operation updates the mapped fields with provided values and the unmapped fields with existing values. Thus, the integrations or queries that perform the Update operation may affect API call usage and take time.
Skyvia performs the additional requests to get the existing values for the unmapped Contacts fields in the following cases:
- If one or more standard fields are not mapped.
- If the object has custom fields, and not all of them are mapped.
Lists and Templates
Due to Heymarket API specifics, the UPDATE operation updates the mapped fields with provided values and the unmapped fields with existing values. Skyvia performs the additional requests to get the existing values for the unmapped Lists and Templates fields. Thus, the integrations or queries that perform the Update operation may affect API call usage and take time.
Filtering Specifics
Heymarket API supports the following native filters:
| Object | Field | Operator |
|---|---|---|
| Contacts | Id | = |
| UpdatedDate | <, <= |
|
| Conversations | UpdatedDate | <, <= |
| Lists | Id | = |
| UpdatedDate | <, <= |
|
| Messages | CreatedDate | >, >= |
| Surveys | Id | = |
| Tags | Id | = |
| UpdatedDate | <, <= |
Use these filters to improve performance and save API calls. You can use filters with other fields or operators, which may increase API call usage.
Custom Fields
You can add custom fields to the Contacts object. All custom fields are strings.
Skyvia performs additional requests to Heymarket API to get the custom field metadata.
Incremental Replication and Synchronization
Skyvia supports Replication with Incremental Updates for the Contacts, Conversations, Inboxes, Lists, Messages, Surveys, Tags, and Templates objects.
Skyvia supports Synchronization for the Contacts and Lists objects.
DML Operations Support
| Operation | Object |
|---|---|
| INSERT, UPDATE, DELETE | Contacts, Lists |
| INSERT, DELETE | Tags |
| UPDATE, DELETE | Templates |
| INSERT | Messages |
| UPDATE | Members |
Supported Actions
Skyvia supports all the common actions for Heymarket.