README

This package provides a very basic, convenient, and unified wrapper for Clickup.

Installation
Usage
Examples
Tests
Changelog
Contributing
Credits
License

Installation

To install the client you need to require the package using composer:

$ composer require testmonitor/clickup-client

Use composer's autoload:

require __DIR__.'/../vendor/autoload.php';

You're all set up now!

Usage

This client only supports oAuth authentication. You'll need an Clickup application to proceed. If you haven't done so, please read up with the Clickup authentication docs on how to create an application.

When your Clickup application is up and running, start with the oAuth authorization:

$oauth = [
    'clientId' => '12345',
    'clientSecret' => 'abcdef',
    'redirectUrl' => 'https://redirect.myapp.com/',
];

$clickup = new \TestMonitor\Clickup\Client($oauth);

header('Location: ' . $clickup->authorizationUrl());
exit();

This will redirect the user to a page asking confirmation for your app getting access to Clickup. Make sure your redirectUrl points back to your app. This URL should point to the following code:

$oauth = [
    'clientId' => '12345',
    'clientSecret' => 'abcdef',
    'redirectUrl' => 'https://redirect.myapp.com/',
];

$clickup = new \TestMonitor\Clickup\Client($oauth);

$token = $clickup->fetchToken($_REQUEST['code']);

When everything went ok, you should have an access token (available through Token object). It will be valid for one hour. After that, you'll have to refresh the token to regain access:

$oauth = ['clientId' => '12345', 'clientSecret' => 'abcdef', 'redirectUrl' => 'https://redirect.myapp.com/'];
$token = new \TestMonitor\Clickup\AccessToken('eyJ0...'); // the token you got last time

$clickup = new \TestMonitor\Clickup\Client($oauth, $token);

Examples

Get a list of Clickup workspaces:

$workspaces = $clickup->workspaces();

Or creating a task, for example (using list id 12345):

$workItem = $clickup->createTask(new \TestMonitor\Clickup\Resources\Task([
    'name' => 'Name of the task',
    'description' => 'Some description',
]), '12345');

Tests

The package contains integration tests. You can run them using PHPUnit.

$ vendor/bin/phpunit

Changelog

Refer to CHANGELOG for more information.

Contributing

Refer to CONTRIBUTING for contributing details.

Credits

Thijs Kok - Lead developer - ThijsKok
Stephan Grootveld - Developer - Stefanius
Frank Keulen - Developer - FrankIsGek

License

The MIT License (MIT). Refer to the License for more information.

testmonitor / clickup-client

Maintainers

Details