Zendesk data source connector
Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply. Serverless interfaces and procedures might differ from classic Elastic Stack deployments. The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Serverless
Preview
Preview
Stack
Preview
9.4+
Preview since 9.4
The Zendesk connector connects directly to the Zendesk API. It enables federated search of tickets, users, and organizations from Zendesk Support in Agent Builder.
You can use this connector in Agent Builder and Workflows.
The Zendesk connector uses Zendesk's REST API with Basic authentication (email and API token). You configure your Zendesk subdomain and credentials when creating the connector.
You can create a Zendesk connector in Stack Management > Connectors or when adding a Zendesk data source.
- Subdomain
- Your Zendesk subdomain (for example,
your-companyforhttps://your-company.zendesk.com). - Authentication
- Basic authentication. Use your Zendesk account email and API token (from Admin Center > Apps and integrations > APIs > Zendesk API). For API token authentication, the username must be in the form
your_email@example.com/tokenand the password is your API token.
| Action | Description |
|---|---|
search |
Search across Zendesk (tickets, users, organizations). Parameters: query (required), sortBy, sortOrder, page, perPage. |
listTickets |
List tickets with pagination. Parameters: page, perPage. |
getTicket |
Get full details of a single ticket by ID. Parameters: ticketId. |
getTicketComments |
List comments on a ticket. Parameters: ticketId (required), page, perPage, include, includeInlineImages. |
Use the Action configuration settings to customize connector networking, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.
- Log in to your Zendesk account.
- Go to Admin Center > Apps and integrations > APIs > Zendesk API.
- Turn on Token access and create a new API token.
- Verify that API access is turned on under Apps and integrations > APIs > API Configuration.
- Copy the token and store it securely.
- When configuring the connector, in the Username field enter
your_email@example.com/token. In the Password field, enter the API token.
When creating or activating a Zendesk data source through a script or API (including the "create new" flow with a single credential string), use the format your_email@example.com/token:your_api_token. Kibana parses this as Basic authentication credentials (username before the colon, password after) and creates the connector with the correct authentication type. Provide the subdomain in the connector configuration (for example, when creating the connector in the UI, or through the API with config: { subdomain: 'your-company' }).