|
article_containers
Article Containers
|
Specify the Category or Section Id to retrieve articles from. Don't add entries to index all articles from all categories
type: array of object
object attributes: {
container_id
(required)
: {
display name: Container Id
type: string
minLength : 1
}
container_type
(required)
: {
display name: Container Type
type: string
enum: {
Category
Section
}
}
}
|
|
auth_key
Authentication Key
required
|
An email address of a valid Zendesk user which must have an admin role.
type: string
minLength: 1
|
|
auth_value
Authentication Value
required
|
This value can be a user password, or an API token. If an API token is used, the Token Auth must be set to true.
type: string
|
|
base_url
Base API URL
required
|
A properly formatted v2 Zendesk API URL. Example: https://yourcompany.zendesk.com/api/v2
type: string
|
|
collection
Collection
|
Collection documents will be indexed to.
type: string
pattern: ^[a-zA-Z0-9_-]+$
|
|
index_article_attachments
Index article attachments
|
If enabled, article attachments will be retrieved
type: boolean
default value: 'false'
|
|
index_articles
Index Articles
|
If enabled, Help Center articles will be indexed using settings on Article Container section
type: boolean
default value: 'false'
|
|
index_tickets
Index Tickets
|
If enabled, tickets will be indexed
type: boolean
default value: 'true'
|
|
organization_id
Organization ID
|
The ID of a Zendesk Organization. This optional setting will allow the Connector to skip records that don't have the same Organization ID.
type: string
|
|
page_size
Page size
|
The number of items to be retrieved on each call. Maximum value is 100
type: integer
default value: '100'
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 100
minimum: 1
|
|
proxy_password
Proxy password
|
Proxy server password.
type: string
|
|
proxy_url
Proxy URL
|
HTTP(S) proxy server URL.
type: string
|
|
proxy_username
Proxy username
|
Proxy server username/login.
type: string
|
|
security_trimming_cache_timeout
Security trimming cache timeout
|
Security trimming cache timeout in seconds.
type: integer
default value: '3600'
|
|
use_token_auth
Token Auth
required
|
Used to determine how the authentication credentials will be formatted. If set to true, the auth_key value will be formatted according to the Zendesk token auth specifications (/).
type: boolean
default value: 'true'
|
|
zendesk_account_plan
Zendesk Account Plan
|
Zendesk applies plan-specific rate limits to API requests. Check https://developer.zendesk.com/rest_api/docs/core/introduction#rate-limits for more information.
type: string
default value: 'essential'
enum: {
essential
team
professional
enterprise
high_volume
}
|
