Skip to content

grokify/lita-zendesk

Repository files navigation

Lita Zendesk Handler

Gem Version Build Status Coverage Status Dependency Status Code Climate Scrutinizer Code Quality Downloads Docs License

lita-zendesk is a handler for Lita that allows you to use the robot with Zendesk ticket queries.

Installation

Add lita-zendesk to your Lita instance's Gemfile:

gem "lita-zendesk"

Configuration

Both Token and Password authentication are supported.

Lita.configure do |config|

  # Zendesk user info
  config.handlers.zendesk.subdomain = 'my_zendesk_subdomain'
  config.handlers.zendesk.username = 'my_zendesk_username'
  config.handlers.zendesk.token = 'my_zendesk_token'       # Use token or password
  config.handlers.zendesk.password = 'my_zendesk_password' # Use token or password

end

Usage

zd or zendesk both work for triggering the handler.

Lita > @lita help
Lita: zd connection - returns information on the Zendesk connection
Lita: zd search tickets <QUERY> - returns search results
Lita: zd tickets - returns the total count of all unsolved tickets
Lita: zd all tickets - returns the count of all tickets
Lita: zd pending tickets - returns a count of tickets that are pending
Lita: zd new tickets - returns the count of all new (unassigned) tickets
Lita: zd escalated tickets - returns a count of tickets with escalated tag that are open or pending
Lita: zd open tickets - returns the count of all open tickets
Lita: zd on hold tickets - returns the count of all on hold tickets
Lita: zd list tickets - returns a list of unsolved tickets
Lita: zd list all tickets - returns a list of all tickets
Lita: zd list pending tickets - returns a list of pending tickets
Lita: zd list new tickets - returns a list of new tickets
Lita: zd list esclated tickets - returns a list of escalated tickets
Lita: zd list open tickets - returns a list of open tickets
Lita: zd list on hold tickets - returns a list of on hold tickets
Lita: zd ticket <ID> - returns information about the specified ticket

Change Log

See CHANGELOG.md

Links

Project Repo

Lita

Zendesk Search API

Ported and enhanced from hubot-scripts/zendesk.coffee:

Contributing

  1. Fork it ( http://github.com/grokify/lita-zendesk/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Lita Zendesk Handler is available under the MIT license. See LICENSE.txt for details.

Lita Zendesk Handler © 2016 by John Wang