List CRM Integrations

curl --request GET \
  --url https://app.herondata.io/api/crm_integrations \
  --header 'x-api-key: <api-key>'

{
  "crm_integrations": [
    {
      "config": {
        "child_file_filtering_enabled": true,
        "data_source_accounts_config": {
          "external_name": "Account",
          "key": "Account",
          "description": "A company or person",
          "external_lookup_config": {
            "external_lookup_fields_and": [
              "<string>"
            ],
            "external_lookup_fields_or": [
              "<string>"
            ],
            "sort_field_name": "CreatedDate",
            "sort_order": "ASC"
          },
          "field_mappings": [
            {
              "field_name": "Name",
              "external_lookup_field_name": null,
              "external_object_name_for_id": "Account",
              "heron_company_attribute_label": "owner_1_first_name",
              "max_length": 255,
              "overwrite_on_update": true,
              "regex_remove": "pattern",
              "required": true,
              "static_value": "static value",
              "static_value_key": "date_today",
              "value_mapping_name": "state",
              "value_type": "Text"
            }
          ],
          "is_optional": false,
          "required_ids": [
            {
              "external_name": "Account",
              "alias": "Company"
            }
          ],
          "static_data": [
            {
              "key": "status",
              "value": "active"
            }
          ]
        },
        "default_id": {
          "external_name": "Account",
          "alias": "Company"
        },
        "object_configs": [],
        "policy_evaluation_config": {
          "external_object_name": "Opportunity",
          "failure_reason_external_name": "Failure_Reason__c",
          "result_external_name": "Submission_Result_from_Heron__c"
        },
        "small_file_filtering_enabled": false,
        "sync_file_classes": {},
        "value_mappings": []
      },
      "instance_url": "https://sandbox.salesforce.com",
      "provider": "<string>",
      "failure_notification_channel": null,
      "heron_id": "<string>",
      "is_enabled": true,
      "is_live": true
    }
  ]
}

GET

api

crm_integrations

List CRM Integrations

curl --request GET \
  --url https://app.herondata.io/api/crm_integrations \
  --header 'x-api-key: <api-key>'

{
  "crm_integrations": [
    {
      "config": {
        "child_file_filtering_enabled": true,
        "data_source_accounts_config": {
          "external_name": "Account",
          "key": "Account",
          "description": "A company or person",
          "external_lookup_config": {
            "external_lookup_fields_and": [
              "<string>"
            ],
            "external_lookup_fields_or": [
              "<string>"
            ],
            "sort_field_name": "CreatedDate",
            "sort_order": "ASC"
          },
          "field_mappings": [
            {
              "field_name": "Name",
              "external_lookup_field_name": null,
              "external_object_name_for_id": "Account",
              "heron_company_attribute_label": "owner_1_first_name",
              "max_length": 255,
              "overwrite_on_update": true,
              "regex_remove": "pattern",
              "required": true,
              "static_value": "static value",
              "static_value_key": "date_today",
              "value_mapping_name": "state",
              "value_type": "Text"
            }
          ],
          "is_optional": false,
          "required_ids": [
            {
              "external_name": "Account",
              "alias": "Company"
            }
          ],
          "static_data": [
            {
              "key": "status",
              "value": "active"
            }
          ]
        },
        "default_id": {
          "external_name": "Account",
          "alias": "Company"
        },
        "object_configs": [],
        "policy_evaluation_config": {
          "external_object_name": "Opportunity",
          "failure_reason_external_name": "Failure_Reason__c",
          "result_external_name": "Submission_Result_from_Heron__c"
        },
        "small_file_filtering_enabled": false,
        "sync_file_classes": {},
        "value_mappings": []
      },
      "instance_url": "https://sandbox.salesforce.com",
      "provider": "<string>",
      "failure_notification_channel": null,
      "heron_id": "<string>",
      "is_enabled": true,
      "is_live": true
    }
  ]
}

Authorizations

x-api-key

string

header

required

Response

200 - application/json

crm_integrations

object[]

Show child attributes

crm_integrations.config

object

required

The configuration for the CRM integration

Show child attributes

crm_integrations.config.child_file_filtering_enabled

boolean

default:true

Whether to filter out child files (files that have a parent file)

crm_integrations.config.data_source_accounts_config

object

The data source accounts configuration for the CRM integration

Show child attributes

crm_integrations.config.data_source_accounts_config.external_name

string

required

The exact name of the object in the CRM

Example:

"Account"

crm_integrations.config.data_source_accounts_config.key

string

required

key should be unique among objects within an integration

Example:

"Account"

crm_integrations.config.data_source_accounts_config.description

string | null

Human-readable description of the object

Example:

"A company or person"

crm_integrations.config.data_source_accounts_config.external_lookup_config

object

Configuration for external lookup

Show child attributes

crm_integrations.config.data_source_accounts_config.external_lookup_config.external_lookup_fields_and

string[]

External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the and condition.

crm_integrations.config.data_source_accounts_config.external_lookup_config.external_lookup_fields_or

string[]

External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the or condition.

crm_integrations.config.data_source_accounts_config.external_lookup_config.sort_field_name

string

default:CreatedDate

The field name to sort by when doing the external lookup

Example:

"CreatedDate"

crm_integrations.config.data_source_accounts_config.external_lookup_config.sort_order

enum<string>

The sort order when doing the external lookup

Available options:

ASC,

DESC

crm_integrations.config.data_source_accounts_config.field_mappings

object[]

Mapping for Heron fields to object fields in CRM

Show child attributes

crm_integrations.config.data_source_accounts_config.field_mappings.field_name

string

required

The name of the field in the CRM

Example:

"Name"

crm_integrations.config.data_source_accounts_config.field_mappings.external_lookup_field_name

string | null

Override field name to use for external lookup instead of the field_name

crm_integrations.config.data_source_accounts_config.field_mappings.external_object_name_for_id

string | null

The external object whose id we want to use populate the field value

Example:

"Account"

crm_integrations.config.data_source_accounts_config.field_mappings.heron_company_attribute_label

string | null

The label of the company attribute in Heron

Example:

"owner_1_first_name"

crm_integrations.config.data_source_accounts_config.field_mappings.max_length

integer | null

The max length of the crm field this should be mapped to. Used for string fields. If set, the string will be truncated.

Example:

255

crm_integrations.config.data_source_accounts_config.field_mappings.overwrite_on_update

boolean

default:true

Whether the field should be overwritten on update. True by default. When False, the field will only be set on creation

Example:

true

crm_integrations.config.data_source_accounts_config.field_mappings.regex_remove

string | null

Any pattern that should be removed from the company attribute value

Example:

"pattern"

crm_integrations.config.data_source_accounts_config.field_mappings.required

boolean

default:false

Whether the field is required

Example:

true

crm_integrations.config.data_source_accounts_config.field_mappings.static_value

string | null

A static value for the field

Example:

"static value"

crm_integrations.config.data_source_accounts_config.field_mappings.static_value_key

enum<string> | null

The value key of the static data

Available options:

date_today,

crm_integrations.config.data_source_accounts_config.field_mappings.value_mapping_name

string | null

Name of the value mapping to use for the field

Example:

"state"

crm_integrations.config.data_source_accounts_config.field_mappings.value_type

string | null

The crm type of the field

Example:

"Text"

crm_integrations.config.data_source_accounts_config.is_optional

boolean

default:false

Whether the object is optional. Optional means that if object fails it will not stop execution of CRM sync

crm_integrations.config.data_source_accounts_config.required_ids

object[]

List of object ids that new object needs

Show child attributes

crm_integrations.config.data_source_accounts_config.required_ids.external_name

string

required

The exact name of the object in the CRM

Example:

"Account"

crm_integrations.config.data_source_accounts_config.required_ids.alias

string | null

An alias for the object in the CRM

Example:

"Company"

crm_integrations.config.data_source_accounts_config.static_data

object[]

Stores static data used by the integration, for example status fields

Show child attributes

crm_integrations.config.data_source_accounts_config.static_data.key

string

required

The key of the static data

Example:

"status"

crm_integrations.config.data_source_accounts_config.static_data.value

any

required

The value of the static data

Example:

"active"

crm_integrations.config.default_id

object

The default object id for the CRM integration

Show child attributes

crm_integrations.config.default_id.external_name

string

required

The exact name of the object in the CRM

Example:

"Account"

crm_integrations.config.default_id.alias

string | null

An alias for the object in the CRM

Example:

"Company"

crm_integrations.config.object_configs

object[]

The object configurations for the CRM integration

Show child attributes

crm_integrations.config.object_configs.external_name

string

required

The exact name of the object in the CRM

Example:

"Account"

crm_integrations.config.object_configs.key

string

required

key should be unique among objects within an integration

Example:

"Account"

crm_integrations.config.object_configs.description

string | null

Human-readable description of the object

Example:

"A company or person"

crm_integrations.config.object_configs.external_lookup_config

object

Configuration for external lookup

Show child attributes

crm_integrations.config.object_configs.external_lookup_config.external_lookup_fields_and

string[]

External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the and condition.

crm_integrations.config.object_configs.external_lookup_config.external_lookup_fields_or

string[]

External lookup fields are what is used to try match potential new objects to existing objects in the CRM (i.e., for deduplication). Used in the or condition.

crm_integrations.config.object_configs.external_lookup_config.sort_field_name

string

default:CreatedDate

The field name to sort by when doing the external lookup

Example:

"CreatedDate"

crm_integrations.config.object_configs.external_lookup_config.sort_order

enum<string>

The sort order when doing the external lookup

Available options:

ASC,

DESC

crm_integrations.config.object_configs.field_mappings

object[]

Mapping for Heron fields to object fields in CRM

Show child attributes

crm_integrations.config.object_configs.field_mappings.field_name

string

required

The name of the field in the CRM

Example:

"Name"

crm_integrations.config.object_configs.field_mappings.external_lookup_field_name

string | null

Override field name to use for external lookup instead of the field_name

crm_integrations.config.object_configs.field_mappings.external_object_name_for_id

string | null

The external object whose id we want to use populate the field value

Example:

"Account"

crm_integrations.config.object_configs.field_mappings.heron_company_attribute_label

string | null

The label of the company attribute in Heron

Example:

"owner_1_first_name"

crm_integrations.config.object_configs.field_mappings.max_length

integer | null

The max length of the crm field this should be mapped to. Used for string fields. If set, the string will be truncated.

Example:

255

crm_integrations.config.object_configs.field_mappings.overwrite_on_update

boolean

default:true

Whether the field should be overwritten on update. True by default. When False, the field will only be set on creation

Example:

true

crm_integrations.config.object_configs.field_mappings.regex_remove

string | null

Any pattern that should be removed from the company attribute value

Example:

"pattern"

crm_integrations.config.object_configs.field_mappings.required

boolean

default:false

Whether the field is required

Example:

true

crm_integrations.config.object_configs.field_mappings.static_value

string | null

A static value for the field

Example:

"static value"

crm_integrations.config.object_configs.field_mappings.static_value_key

enum<string> | null

The value key of the static data

Available options:

date_today,

crm_integrations.config.object_configs.field_mappings.value_mapping_name

string | null

Name of the value mapping to use for the field

Example:

"state"

crm_integrations.config.object_configs.field_mappings.value_type

string | null

The crm type of the field

Example:

"Text"

crm_integrations.config.object_configs.is_optional

boolean

default:false

Whether the object is optional. Optional means that if object fails it will not stop execution of CRM sync

crm_integrations.config.object_configs.required_ids

object[]

List of object ids that new object needs

Show child attributes

crm_integrations.config.object_configs.required_ids.external_name

string

required

The exact name of the object in the CRM

Example:

"Account"

crm_integrations.config.object_configs.required_ids.alias

string | null

An alias for the object in the CRM

Example:

"Company"

crm_integrations.config.object_configs.static_data

object[]

Stores static data used by the integration, for example status fields

Show child attributes

crm_integrations.config.object_configs.static_data.key

string

required

The key of the static data

Example:

"status"

crm_integrations.config.object_configs.static_data.value

any

required

The value of the static data

Example:

"active"

crm_integrations.config.policy_evaluation_config

object

The policy evaluation configuration for the CRM integration

Show child attributes

crm_integrations.config.policy_evaluation_config.external_object_name

string

required

The object to write policy evaluation results to

Example:

"Opportunity"

crm_integrations.config.policy_evaluation_config.failure_reason_external_name

string

The field to write policy evaluation failure reason to

Example:

"Failure_Reason__c"

crm_integrations.config.policy_evaluation_config.result_external_name

string

The field to write policy evaluation results

Example:

"Submission_Result_from_Heron__c"

crm_integrations.config.small_file_filtering_enabled

boolean

default:false

Whether to filter out files smaller than 400 bytes

crm_integrations.config.sync_file_classes

object

Whether to sync files of a given class, including emails

Show child attributes

crm_integrations.config.sync_file_classes.{key}

boolean

crm_integrations.config.value_mappings

object[]

A list of value mappings for the CRM integration

Show child attributes

crm_integrations.config.value_mappings.mapping

object

required

The mapping of values

Show child attributes

crm_integrations.config.value_mappings.mapping.{key}

any

Example:

{ "CA": "California", "NY": "New York" }

crm_integrations.config.value_mappings.name

string

required

The name of the value mapping

Example:

"Status"

crm_integrations.config.value_mappings.default_value

string | null

The default value to use when no match is found

Example:

"Default"

crm_integrations.config.value_mappings.description

string | null

A human-readable description of the value mapping

Example:

"The status of the company"

crm_integrations.config.value_mappings.use_partial_match

boolean

default:false

Whether to use partial match when mapping values

crm_integrations.instance_url

string<url>

required

Base URL of the CRM integration

Example:

"https://sandbox.salesforce.com"

crm_integrations.provider

string

required

The CRM provider

crm_integrations.failure_notification_channel

string | null

The channel to send failure notifications to

crm_integrations.heron_id

string

crm_integrations.is_enabled

boolean

default:true

Whether the integration is enabled

Example:

true

crm_integrations.is_live

boolean

default:true

Whether the integration is live

Example:

true

Reset API token Create a CRM integration

⌘I

API Reference

AppStore

Categories

Credentials

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEnrichers

EndUserEntity

EndUserFiles

FileClass

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

Policy

Positions

EnrichedTransactions

Transactions

Funders

Testing

Merchants

Rules

ParsedEndUserSubmission

UserMerchantGroups

Users

Watermarks

Webhooks

Workflows

List CRM Integrations

Authorizations

Response