Brightpearl API Configuration Lite
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "brightpearl",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"app_reference": "your_brightpearl_app_reference",
"data_center": "euw1",
"client_secret": "your_brightpearl_client_secret",
"developer_reference": "your_brightpearl_developer_reference",
"organization_name": "your_brightpearl_organization_name",
"client_id": "your_brightpearl_client_id",
"schema": "schema_name"
}
}Config parameters
| Name | Description |
|---|---|
app_reference | Your Brightpearl app reference. |
data_center | Your Brightpearl data center. |
client_secret | Your Brightpearl client secret. |
developer_reference | Your Brightpearl dev reference. |
organization_name | Your Brightpearl organization name. |
client_id | Your Brightpearl client ID. |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_id,client_secret,developer_reference,app_reference,data_centerandorganization_nameparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "brightpearl", "group_id": "group_id", "config": { "client_id": "your_brightpearl_client_id", "client_secret": "your_brightpearl_client_secret", "developer_reference": "your_brightpearl_developer_reference", "app_reference": "your_brightpearl_app_reference", "data_center": "euw1", "organization_name": "your_brightpearl_organization_name" } }By using the Connect Card or the Fivetran dashboard.