huddledigital/zendesk-laravel

Laravel wrapper for zendesk/zendesk_api_client_php package

Laravel Zendesk

This package provides integration with the Zendesk API. It supports creating tickets, retrieving and updating tickets, deleting tickets, etc., _(*1)

The package simply provides a Zendesk facade that acts as a wrapper to the zendesk/zendesk_api_client_php package., _(*2)

NB: Currently only supports token-based authentication., _(*3)

Installation

You can install this package via Composer using:, _(*4)

composer require huddledigital/zendesk-laravel

You must also install the service provider., _(*5)

Laravel 5.5+ users: this step may be skipped, as the package supports auto discovery., _(*6)

// config/app.php
'providers' => [
    ...
    Huddle\Zendesk\Providers\ZendeskServiceProvider::class,
    ...
];

If you want to make use of the facade you must install it as well., _(*7)

// config/app.php
'aliases' => [
    ..
    'Zendesk' => Huddle\Zendesk\Facades\Zendesk::class,
];

Configuration

To publish the config file to app/config/zendesk-laravel.php run:, _(*8)

php artisan vendor:publish --provider="Huddle\Zendesk\Providers\ZendeskServiceProvider"

Set your configuration using environment variables, either in your .env file or on your server's control panel:, _(*9)

• ZENDESK_SUBDOMAIN

The subdomain part of your Zendesk organisation URL., _(*10)

e.g. http://huddledigital.zendesk.com use huddledigital, _(*11)

• ZENDESK_USERNAME

The username for the authenticating account., _(*12)

• ZENDESK_TOKEN

The API access token. You can create one at: https://SUBDOMAIN.zendesk.com/agent/admin/api/settings, _(*13)

• ZENDESK_DRIVER (Optional)

Set this to null or log to prevent calling the Zendesk API directly from your environment., _(*14)

Usage

Facade

The Zendesk facade acts as a wrapper for an instance of the Zendesk\API\Client class. Any methods available on this class (documentation here) are available through the facade. for example:, _(*15)

// Get all tickets
Zendesk::tickets()->findAll();

// Create a new ticket
Zendesk::tickets()->create([
  'subject' => 'Subject',
  'comment' => [
      'body' => 'Ticket content.'
  ],
  'priority' => 'normal'
]);

// Update multiple tickets
Zendesk::ticket([123, 456])->update([
  'status' => 'urgent'
]);

// Delete a ticket
Zendesk::ticket(123)->delete();

Dependency injection

If you'd prefer not to use the facade, you can skip adding the alias to config/app.php and instead inject Huddle\Zendesk\Services\ZendeskService into your class. You can then use all of the same methods on this object as you would on the facade., _(*16)

<?php

use Huddle\Zendesk\Services\ZendeskService;

class MyClass {

    public function __construct(ZendeskService $zendesk_service) {
        $this->zendesk_service = $zendesk_service;
    }

    public function addTicket() {
        $this->zendesk_service->tickets()->create([
              'subject' => 'Subject',
              'comment' => [
                    'body' => 'Ticket content.'
              ],
              'priority' => 'normal'
        ]);
    }

}

This package is available under the MIT license., _(*17)