Skip to main content
First time creating a connector? Read this first.
Ingest your files into Unstructured from Zendesk.

​
Requirements

You will need:
  • A Zendesk account.
  • Your Zendesk subdomain, for example, the <organization> part of <organization>.zendesk.com.
  • The login email address for your Zendesk account.
  • An API token (not an OAuth token) for your login email address.

​
Examples

To create a Zendesk source connector, see the following examples. For more information on working with source connectors using the Unstructured API, see Source endpoints. 
import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type="zendesk",
                config={
                    "subdomain": "<subdomain>",
                    "email": "<email>",
                    "api_token": "<api-token>",
                    "item_type": "<item-type>",
                    "batch_size": <batch-size>
                }
            )
        )
    )

    print(response.source_connector_information)

​
Configuration Settings

Replace the preceding placeholders as follows:
​
name
string
required
A unique name for this connector.
​
subdomain
string
required
The subdomain of your Zendesk site, for example the <organization> part of <organization>.zendesk.com.
​
email
string
required
The email address of the user account that has access to the Zendesk subdomain.
​
api-token
string
required
The API token (not an OAuth token) for the user account. For more information, see Managing access to the Zendesk API.
​
item-type
string
default:"tickets"
The type of item to parse. Allowed values include tickets and articles.
​
batch-size
integer
default:"2"
The maximum number of items to structure per batch.

​
Learn more