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 Starter account, at https://platform.unstructured.io. To sign up for a Team or Enterprise account instead, contact Unstructured Sales, or learn more.
- If you already have an Unstructured Starter or Team account and are not already signed in, sign in to your account at https://platform.unstructured.io. For an Enterprise account, see your Unstructured account administrator for instructions, or email Unstructured Support at support@unstructured.io.
-
After you sign in to your Unstructured Starter account, click API Keys on the sidebar.
For a Team or Enterprise 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. -
Click Generate API Key.
-
Follow the on-screen instructions to finish generating the key.
-
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.
- 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.
<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 includetickets
andarticles
. If no value is provided, the default istickets
.<batch-size>
: The maximum number of items to structure per batch. The default is2
.