This documentation describes an old release, version 2024.5.30. Documentation for the latest release, 2025.4.24, can be found here.

Module - zendesk.config¶

Credentials¶

API resource to extend a record.
type	object
properties
collection_path	Collection Path
	Path to access collections.
	type	array
	examples	[“tickets”, “metrics”]
	items	type	string
	minItems	1
new_field_name	New Field Name
	Field that will be added to existing record and contain the result of the resource call. If not provided - the value will be generated using collection_path field by joining ‘_’ with list values.
	type	string
	examples	ticket_metrics
additionalProperties	False

ZendeskInput configuration.
type	object
properties
credentials	Credentials
	anyOf	type	string
		Credentials
collection_path	Collection Path
	Path to access collections.
	type	array
	examples	[“tickets”, “incremental”]
	items	type	string
	minItems	1
id	Id
	Object id for request
	type	string
	examples	str
include	Include
	List of side-loaded records
	type	array
	examples	[“users”, “permissions”]
	items	type	string
search_query	Search Query
	Query for required for search request
	type	string
	examples	test query
extend_resources	Extend Resources
	List of API resources to extend each records with. This will result in additional HTTP calls for each record.
	type	array
	default
	items	ExtendResource
definitions
Credentials	Credentials
	Zendesk credentials.
	type	object
	properties
	email	Email
		type	string
		minLength	4
	subdomain	Subdomain
		type	string
		minLength	1
	token	Token
		type	string
	oauth_token	Oauth Token
		type	string
ExtendResource	ExtendResource
	API resource to extend a record.
	type	object
	properties
	collection_path	Collection Path
		Path to access collections.
		type	array
		examples	[“tickets”, “metrics”]
		items	type	string
		minItems	1
	new_field_name	New Field Name
		Field that will be added to existing record and contain the result of the resource call. If not provided - the value will be generated using collection_path field by joining ‘_’ with list values.
		type	string
		examples	ticket_metrics
	additionalProperties	False