Zendesk Support

Supports:

✅ Models
✅ Model sync destination
✅ Bulk sync source
✅ Connection Proxy

Connection

Configuration

Name	Type	Description	Required
`auth_method`	`string`	Authentication method Accepted values: `apitoken` ↓, `clientcredentials` ↓, `oauth`	`true`
`custom_api_limits`	`boolean`	Enforce custom API limits ↓	`false`
`domain`	`string`	Zendesk Subdomain	`true`
`oauth_refresh_token`	`string`	(required if `auth_method` is “oauth”)	`false`

`auth_method`

When `auth_method` is `apitoken`

Name	Type	Description	Required
`api_token`	`string`	API token	`true`
`email`	`string`	Email	`true`

When `auth_method` is `clientcredentials`

Name	Type	Description	Required
`client_id`	`string`	Client ID	`true`
`client_secret`	`string`	Client secret	`true`

`custom_api_limits`

When `custom_api_limits` is `true`

Name	Type	Description	Required
`ratelimit_rpm`	`integer`	Maximum requests per minute Set a custom maximum request per minute limit.	`true`

Example

1 {
2   "name": "Zendesk Support connection",
3   "type": "zendesk_support",
4   "configuration": {
5     "api_token": "secret-token",
6     "auth_method": "apitoken",
7     "custom_api_limits": false,
8     "domain": "polytomic.zendesk.com",
9     "email": "user@example.com",
10     "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
11   }
12 }

Model Sync

Source

Configuration

Name	Type	Description	Required
`object`	`string`	Object	`true`

Example

1 {
2   ...
3   "configuration": {
4     "object": "tickets"
5   }
6 }

Target

Zendesk Support connections may be used as the destination in a model sync.

All targets

Configuration

Name	Type	Description	Required
`replace_relationships`	`boolean`	Replace existing relationships	`false`

Example

1 {
2   ...
3   "target": {
4       "configuration": {
5         "replace_relationships": false
6     }
7   }
8 }

Bulk Sync

Source

Zendesk Support connections may be used as a bulk sync source. No additional configuration options are required.

Connection

Configuration

auth_method

When auth_method is apitoken

When auth_method is clientcredentials

custom_api_limits

When custom_api_limits is true

Example

Model Sync

Source

Configuration

Example

Target

All targets

Configuration

Example

Bulk Sync

Source

`auth_method`

When `auth_method` is `apitoken`

When `auth_method` is `clientcredentials`

`custom_api_limits`

When `custom_api_limits` is `true`