3tinkers/zendesk-java-client

A Java client library for interacting with Zendesk

Zendesk Java Client

This is a Zendesk client implementation written in Java using AsyncHttpClient and Jackson.

Using the API

Start by creating a Zendesk instance

Zendesk zd = new Zendesk.Builder("https://{{your domain}}.zendesk.com")
        .setUsername("...")
        .setToken("...") // or .setPassword("...")
        .build();

If you are behind a proxy, or want to otherwise control the lifecycle of the AsyncHttpClient instance you should pass that through to the builder too. If you don't pass an AsyncHttpClient instance to the builder it will create its own which will be closed by the Zendesk.close() method.

Where methods return paged data sets, an Iterable is returned that will lazy-fetch one page at a time until all records have been fetched, so e.g.

for (Ticket ticket: zd.getTickets()) {
    ...
}

will iterate through all tickets. Most likely you will want to implement your own cut-off process to stop iterating when you have got enough data.

Mailing lists

• Users list

Status

Here is the status of the various API components:

• Tickets ✓
• Ticket Audits ✓
• Incremental Export - Partial (tickets, users, organizations only)
• Ticket Fields ✓
• Ticket Import ✓
• Ticket Metrics ✓
• Ticket Forms getTicketForm() and getTicketForms()
• Views
• Users ✓
  • User Related Information ✓
• User Fields - Partial - List User Fields (getUserField())
• Requests ✓
• User Identities ✓
• Groups ✓
• Group Membership ✓
• Custom Agent Roles ✓
• Organizations ✓ except for related info
• Search ✓ except for topics and sort ordering
• Tags
• Forums ✓
• Forum Subscriptions
• Categories
• Topics ✓
• Topic Comments
• Topic Subscriptions
• Help Center Categories ✓
• Help Center Sections ✓
• Help Center Articles ✓
• Help Center Translations - Partial (List Translations, Update Translation)
• Help Center Subscriptions
• Topic Votes
• Account Settings
• Activity Stream
• Attachments ✓
• Autocompletion
• Automations ✓
• Job Statuses
• Locales
• Macros ✓ except for restrictions
• Restrictions and Responsibilities
• Satisfaction Ratings ✓
• Sharing Agreements
• Suspended Tickets
• Triggers ✓

History

• 0.0.x - Initial release series

• 0.1.x - Switched from Integer as the id type to Long due to reports of overflow

• 0.2.x - At request of Zendesk, renamed ZenDesk to Zendesk

• 0.3.x - Fixed infinite loop with PagedIterable, updated async-http-client dependency to 1.9.x.

• 0.4.x - Few API breakage (in particular changed userId to Long in Identity), updated async-http-client dependency to latest.

• 0.5.x - ...

• 0.6.x - Requires Java 8, Upgrade async-http-client to 2.2.0, Jackson to 2.9.3 (+ others updates), Add createTicketAsync method, Add method to inline an article attachment, Add created article,section,category translation, Add suspend user, Add ticket form creation functionality, From now custom field value is an array with multiple value due to Multi-select fields, Changed type of article attachment ID and article ID from int to Long, Include response body in stacktrace message, Added permanently GDPR delete of Tickets and User

• 0.7.x - The Help Center Section creation was fixed, Macro DTO was updated (Id is long), Permanent deletion of a handful of Items was added ( GDPR compliancy )

• 0.8.x - New method ListenableFuture<JobStatus<Ticket>> updateTicketsAsync(List<Ticket> tickets) to update many ticket at once (thx @wakingrufus - PR #260), new method UserRelatedInfo getUserRelatedInfo(long userId) to get User Related Information (thx @caionovaes - PR #268)