The unofficial Ruby Library for interacting with the Zendesk REST API
- ActiveResource gem
- Curl
- Curb gem
- Ruby wrapper around the Zendesk REST API
Normal install: gem install zendesk-api
Bundler install: gem "zendesk-api", "latestversion"
Below outputs xml z = Zendesk::Main.new('subdomain', 'username', 'password') and outputs json z = Zendesk::Main.new('subdomain', 'username', 'password', :format => 'json')
For the most part all functions is based on the following functions REST function_names = %{user, organization, group, ticket,attachement, tag, forum, entries, search}
z.get_function_name(user_id)
e.g. z.get_user(121)
z.get_function_names #with a s in the end, for plural
e.g. z.get_users
with string z.create_function_name("email@company.comJohn Doe") with hash(array is not supported yet) z.create_function_name({:email => 'email@company.com', :name => 'John Doe'})
Not supported yet
z.destroy_function_name(id)
e.g. z.destroy_user(234)
The Zendesk library comes with a convenient console for testing and quick commands (or whatever else you want to use it for).
From /
irb -r lib/zendesk/console
z = Zendesk::Main.new('accountname', 'username', 'password')
z.get_users