curl --request POST \
--url https://app.herondata.io/api/crm_integrations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"auth": {},
"config": {
"child_file_filtering_enabled": true,
"object_configs": [],
"small_file_filtering_enabled": false,
"sync_file_classes": {},
"value_mappings": []
},
"instance_url": "https://sandbox.salesforce.com",
"provider": "<string>",
"secret": "<string>",
"failure_notification_channel": null,
"is_enabled": true,
"is_live": true
}
'{
"crm_integration": {
"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
}
}Create a CRM integration, e.g., with Salesforce
curl --request POST \
--url https://app.herondata.io/api/crm_integrations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"auth": {},
"config": {
"child_file_filtering_enabled": true,
"object_configs": [],
"small_file_filtering_enabled": false,
"sync_file_classes": {},
"value_mappings": []
},
"instance_url": "https://sandbox.salesforce.com",
"provider": "<string>",
"secret": "<string>",
"failure_notification_channel": null,
"is_enabled": true,
"is_live": true
}
'{
"crm_integration": {
"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
}
}Authentication details for the CRM integration
Show child attributes
The configuration for the CRM integration
Show child attributes
Base URL of the CRM integration
"https://sandbox.salesforce.com"
The CRM provider
A secret key for the CRM integration
The channel to send failure notifications to
Whether the integration is enabled
true
Whether the integration is live
true
Created
Show child attributes
Was this page helpful?