Zendesk Support API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "zendesk",
"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": {
"domain": "domain",
"api_token": "api_token",
"historical_sync_time_frame": "ALL_TIME | DATE_LIMIT",
"email": "email",
"api_usage": 50,
"backward_sync_limit": "2023-01-11",
"schema": "schema_name"
},
"auth": {
"access_token": "my_access_token"
}
}Config parameters
| Name | Description |
|---|---|
domain | Zendesk domain. |
api_token | Zendesk API tokens are auto-generated passwords in the Support admin interface. |
historical_sync_time_frame | Used to configure Historical sync timeframe for selected tables |
email | Zendesk email. |
api_usage | Maximum Zendesk Api Usage allowed |
backward_sync_limit | Date Limit of the Historical Sync Time for selected tables. The format should be YYYY-MM-DD |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are three ways to authorize this connector type:
API access token: By specifying the values for the
domain,emailandapi_tokenparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "zendesk", "group_id": "group_id", "config": { "domain": "domain", "email": "email", "api_token": "api_token" } }Access token: By specifying the value for the
access_tokenparameter in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "zendesk", "group_id": "group_id", "auth": { "access_token": "my_access_token" } }Auth Parameters
Name Description access_tokenThe long-lived Access tokencarries the information necessary to access API resources.By using the Connect Card or the Fivetran dashboard.