Zendesk

If you’re new to Unstructured, read this note first.

Before you can create a source connector, you must first sign in to your Unstructured account:

• If you do not already have an Unstructured account, sign up for free. After you sign up, you are automatically signed in to your new Unstructured Let’s Go account, at https://platform.unstructured.io. To sign up for a Business account instead, contact Unstructured Sales, or learn more.
• If you already have an Unstructured Let’s Go, Pay-As-You-Go, or Business SaaS account and are not already signed in, sign in to your account at https://platform.unstructured.io. For other types of Business accounts, see your Unstructured account administrator for sign-in instructions, or email Unstructured Support at [e-mail].

After you sign in, the Unstructured user interface (UI) appears, which you use to get your Unstructured API key, as follows:

1. After you sign in to your Unstructured Let’s Go, Pay-As-You-Go, or Business account, click API Keys on the sidebar.
   

   For a Business account, before you click API Keys, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. Learn more.

2. Click Generate API Key.
   

3. Follow the on-screen instructions to finish generating the key.
   

4. Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
   

After you create the source connector, add it along with a destination connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.

You can also create source connectors with the Unstructured user interface (UI). Learn how.

If you need help, email Unstructured Support at [e-mail].

You are now ready to start creating a source connector! Keep reading to learn how.

Ingest your files into Unstructured from Zendesk.

The requirements are as follows.

• 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.

To create a Zendesk source connector, see the following examples.

Python SDK

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)

Replace the preceding placeholders as follows:

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

Learn more

•   Unlock Customer Support Knowledge: Unstructured Integrates with Zendesk