bluemove/laravel-zendesk

A Laravel Zendesk library for integrating with the Zendesk API

1.0.0 2016-02-04 06:35 UTC

Requires

• php: >=5.5.0
• illuminate/support: >=4.0.0
• zendesk/zendesk_api_client_php: ~2.0

MIT

• Superbalist.com a division of Takealot Online (Pty) Ltd

README

A Laravel Zendesk library for integrating with the Zendesk API

This package provides a Laravel service provider and facade for the zendesk/zendesk_api_client_php package.

Installation

composer require bluemove/laravel-zendesk

Register the service provider in app.php

'providers' => array(
    'Bluemove\Zendesk\ZendeskServiceProvider',
)

Register the facade in app.php

'aliases' => array(
    'Zendesk' => 'Bluemove\Zendesk\ZendeskFacade',
)

Create a services.php config file.

<?php

return array(

    'zendesk' => array(
        'subdomain' => '[[your zendesk subdomain]]',
        'username' => '[[your zendesk username]]',
        'token' => '[[your zendesk api token]]',
    ),

);

Usage

Please see https://github.com/zendesk/zendesk_api_client_php for full documentation on the core API.

All functions provided by the core API are available behind the Zendesk facade in Laravel.

use Zendesk;

// get all tickets
$zendesk = Zendesk::tickets()->findAll();

// create a new ticket
$ticket = Zendesk::tickets()->create([
    'subject' => 'The quick brown fox jumps over the lazy dog',
    'comment' => [
        'body' => 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, ' .
                  'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
    ],
    'priority' => 'normal'
]);

$newUser = Zendesk::users()->create([
    'name'  => 'Roger Rabit',
    'alias'  => 'Roger Rabit',
    'email'  => '[e-mail]',
    'external_id' => '123456'
   
]);