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",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "SOURCE_NAMING",
  "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",
    "client_access": {
      "client_secret": "my_client_secret",
      "client_id": "my_client_id"
    }
  }
}

Config parameters

Name	Description
`domain`	Zendesk domain.
`api_token`	Deprecated: Use Confidential OAuth client authentication instead. 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` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are three ways to authorize this connector type:

Confidential OAuth client authentication: By specifying the value for the client_access parameter in the auth section and the value for the domain parameter in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "zendesk",
  "group_id": "group_id",
  "config": {
    "domain": "domain"
  },
  "auth": {
    "client_access": {
      "client_secret": "my_client_secret",
      "client_id": "my_client_id"
    }
  }
}

Auth Parameters

Name	Description
`client_access`	Confidential OAuth client credentials for your application.
`client_access.client_secret`	`Client Secret` of your Zendesk Confidential OAuth client app.
`client_access.client_id`	`Identifier` of your Zendesk Confidential OAuth client app.

API access token (deprecated): By specifying the values for the domain, email and api_token parameters 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"
  }
}
```
By using the Connect Card or the Fivetran dashboard.