https://github.com/catarse/zendesk_engine

Create tickets using Zendesk API through a ready to use moutable controller
https://github.com/catarse/zendesk_engine

Last synced: 2 months ago
JSON representation

Create tickets using Zendesk API through a ready to use moutable controller

• Host: GitHub
• URL: https://github.com/catarse/zendesk_engine
• Owner: catarse
• License: mit
• Created: 2014-07-17T15:59:53.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-08-03T06:05:12.000Z (over 3 years ago)
• Last Synced: 2024-09-22T14:38:27.328Z (4 months ago)
• Language: Ruby
• Size: 40 KB
• Stars: 3
• Watchers: 5
• Forks: 3
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# ZendeskEngine [ ![Codeship Status for catarse/zendesk_engine](https://codeship.io/projects/9a3ec7c0-f00e-0131-0889-62f1bdfbd872/status)](https://codeship.io/projects/27276) [![Code Climate](https://codeclimate.com/github/catarse/zendesk_engine.png)](https://codeclimate.com/github/catarse/zendesk_engine)

## Install and configure

Just add to your Gemfile:

    gem 'zendesk_engine'

And create an initializer in ```config/initializers/zendesk_engine.rb``` with your Zendesk credentials:

    ZendeskEngine.configure do |config|

      config.url   = 'https://foocompany.zendesk.com/api/v2'

      config.user  = '[email protected]'

      config.token = 'my zendesk token found in API config'

    end

## Mount the routes

Add to your ```config/routes.rb```:

```ruby

MyApplication::Application.routes.draw do

  mount ZendeskEngine::Engine => "/"

end

```

This will add the /tickets resources route to the path you've chosen as mouting point ("/" in the example above).

## Make requests

After this you can post tickets to /tickets and they will be relayed to the Zendesk API via the zendesk_api gem ;)

The parameters to ticket creation should be:

```ruby

{

  user: {

    email: '[email protected]',

    name: 'Foo Bar'

  },

  ticket: {

    subject: 'Awesome ticket',

    comment: {value: 'This is a ticket just to show a cool example'},

    priority: 'urgent'

  }

}

```

The response will be a json with the created ticket.

This project rocks and uses MIT-LICENSE.